A B C D E F G H I J L M N O P S T X

A

addColourBeans(String, String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Add a fill colour to the beans on a graph whose name, id's or classname match the supplied string.

addFileset(FileSet) - Method in class org.springframework.beandoc.client.AntTask

Specify a set of files to be used as the target for the BeanDoc task.

addIgnoreBeans(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Add a naming pattern of bean id's or bean names or classnames that should not be displayed on output.

addLocation(String, String) - Method in class org.springframework.beandoc.output.JavaDocDecorator

Add a JavaDoc location used in the output documents to link classnames to their JavaDoc pages.

addRankBeans(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Add a naming pattern of bean id's or bean names or classnames that should be constrained to the same rank of a graph.

afterPropertiesSet() - Method in class org.springframework.beandoc.DefaultContextProcessor

afterPropertiesSet() - Method in class org.springframework.beandoc.util.LocalizedDateFactoryBean

Setup the DateFormat managed object based on the supplied locale (or System default locale if none is supplied)

AntTask - Class in org.springframework.beandoc.client

Ant task that sets up and runs the beandoc tool based on a properties file containing all configuration options.

AntTask() - Constructor for class org.springframework.beandoc.client.AntTask

ATTRIBUTE_BD_DO_FILENAME - Static variable in class org.springframework.beandoc.Tags

Internal attributes (For use in ContextProcessor, Decorator and Transformer)

ATTRIBUTE_BD_FB_FILENAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_BD_FILENAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_BD_KR_FILENAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_BD_P_FILENAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_BD_PATHRELATIVE - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_BD_VR_FILENAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_CLASSNAME - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_COLOUR - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_DEPENDS_ON - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_FACTORY_BEAN - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_GRAPH_BEANSHAPE - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_CONSOLIDATED - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_FONTNAME - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_FONTSIZE - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_IGNORE - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_LABELLOCATION - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_RANK - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_RATIO - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_SIZE - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_GRAPH_TYPE - Static variable in class org.springframework.beandoc.output.GraphVizDecorator

ATTRIBUTE_ID - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_JAVADOC - Static variable in class org.springframework.beandoc.output.JavaDocDecorator

ATTRIBUTE_KEY_REF - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_NAME - Static variable in class org.springframework.beandoc.Tags

Literals

ATTRIBUTE_PARENT - Static variable in class org.springframework.beandoc.Tags

Attributes that are references:

ATTRIBUTE_PROXY_FOR - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_REF_BEAN - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_REF_LOCAL - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_REF_REPLACER - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_RESOURCE - Static variable in class org.springframework.beandoc.Tags

ATTRIBUTE_VALUE_REF - Static variable in class org.springframework.beandoc.Tags

B

BeanDocClient - Class in org.springframework.beandoc.client

Command line client for the beandoc tool.

BeanDocClient() - Constructor for class org.springframework.beandoc.client.BeanDocClient

BeanDocException - Exception in org.springframework.beandoc

Wrapper exception for problems occurring in the BeanDocEngine.

BeanDocException() - Constructor for exception org.springframework.beandoc.BeanDocException

BeanDocException(String) - Constructor for exception org.springframework.beandoc.BeanDocException

BeanDocException(String, Throwable) - Constructor for exception org.springframework.beandoc.BeanDocException

BeanDocException(Throwable) - Constructor for exception org.springframework.beandoc.BeanDocException

BeanDocUtils - Class in org.springframework.beandoc.util

Collection of static utility methods used by BeanDoc.

C

compile(Document[], File) - Method in interface org.springframework.beandoc.output.DocumentCompiler

Perform any required documentation compilation steps.

compile(Document[], File) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

Generates actual images and HTML image maps (as required) from the dot files created by DotFileTransformer.

consolidatedDocument - Variable in class org.springframework.beandoc.output.ConsolidatedTransformer

ConsolidatedTransformer - Class in org.springframework.beandoc.output

Generates a consolidated Document from the array of individual Document objects and allows subclasses to transform this instead.

ConsolidatedTransformer() - Constructor for class org.springframework.beandoc.output.ConsolidatedTransformer

ConsolidatedTransformer(String) - Constructor for class org.springframework.beandoc.output.ConsolidatedTransformer

ContextProcessor - Interface in org.springframework.beandoc

ContextProcessor handles the workflow for the beandoc tool.

convertStringsToPatterns(Collection) - Static method in class org.springframework.beandoc.util.PatternMatcher

Convert a collection of String objects to an array of compiled regex Patterns.

createBeanElement(BeanDefinitionHolder, Document) - Method in class org.springframework.beandoc.DefaultContextProcessor

createBeanElement(BeanDefinition, Document, String) - Method in class org.springframework.beandoc.DefaultContextProcessor

CsvDecorator - Class in org.springframework.beandoc.output

From the example in the Reference Docs.

CsvDecorator() - Constructor for class org.springframework.beandoc.output.CsvDecorator

specify only 'bean' elements as a Filter - we're not interested in decorating anything else

CsvTransformer - Class in org.springframework.beandoc.output

From the example in the Reference Docs.

CsvTransformer() - Constructor for class org.springframework.beandoc.output.CsvTransformer

D

decorate(Document[]) - Method in interface org.springframework.beandoc.output.Decorator

Decorators act incrementally, this method allows the implementor to further modify any previously modified DOM trees by previous Decorators.

decorate(Document[]) - Method in class org.springframework.beandoc.output.SimpleDecorator

Permits decoration of the document by iterating all the filtered child elements in the Documents supplied and calls a decorateElement() for each one.

decorateElement(Element) - Method in class org.springframework.beandoc.output.CsvDecorator

decorateElement(Element) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Decorates root element with graph type attributes and each bean element as required with colour information.

decorateElement(Element) - Method in class org.springframework.beandoc.output.HtmlDecorator

decorateElement(Element) - Method in class org.springframework.beandoc.output.JavaDocDecorator

decorateElement(Element) - Method in class org.springframework.beandoc.output.SimpleDecorator

Each Element in each input Document is iteratively passed to this method allowing subclasses to add or amend any attributes they desire.

Decorator - Interface in org.springframework.beandoc.output

Decorator implementations have the opportunity to modify the DOM trees built by a Processor instance.

DefaultContextProcessor - Class in org.springframework.beandoc

Default implementation of the ContextProcessor interface that generates documentation in a file system directory.

DefaultContextProcessor(Resource[], File) - Constructor for class org.springframework.beandoc.DefaultContextProcessor

Construct with an array of Spring Resources used as input files for the program

DefaultContextProcessor(String[], File) - Constructor for class org.springframework.beandoc.DefaultContextProcessor

Construct with an array of resource names that will resolve to one or more input resources using standard Spring Resource resolution strategies.

DefaultContextProcessor(String[], String) - Constructor for class org.springframework.beandoc.DefaultContextProcessor

Construct with an array of resource names that will resolve to one or more input resources using standard Spring Resource resolution strategies.

DocumentCompiler - Interface in org.springframework.beandoc.output

DocumentCompiler implementations do the work of plugging the various output documents from the transformation stage together.

DocumentCompilerImpl - Class in org.springframework.beandoc.output

Default implementation of the DocumentCompiler interface.

DocumentCompilerImpl() - Constructor for class org.springframework.beandoc.output.DocumentCompilerImpl

DotFileTransformer - Class in org.springframework.beandoc.output

Generates graphs from the context files, firstly transforming the XML to an intermediate .dot file that GraphViz uses to generate the actual images.

DotFileTransformer() - Constructor for class org.springframework.beandoc.output.DotFileTransformer

constructs the Transformer with a default stylesheet included in the beandoc tool.

DotFileTransformer(String) - Constructor for class org.springframework.beandoc.output.DotFileTransformer

constructs the Transformer with the stylesheet provided.

doXslTransform(Document, File) - Method in class org.springframework.beandoc.output.XslTransformer

perform the actual tree transformation to the output directory for the given Document

E

EchoTransformer - Class in org.springframework.beandoc.output

Transformer that simply echoes the XML representation of the decorated DOM.

EchoTransformer() - Constructor for class org.springframework.beandoc.output.EchoTransformer

execute() - Method in class org.springframework.beandoc.client.AntTask

Load and run the default beandoc processor wrapping any Exception as an Ant BuildException.

F

FilenameAppenderStrategy - Class in org.springframework.beandoc.output

FilenameAppenderStrategy is a trivial implementation that simply appends a String to the end of the input file name in order to produce the output name.

FilenameAppenderStrategy(String) - Constructor for class org.springframework.beandoc.output.FilenameAppenderStrategy

takes the String that will be appended to the input name to produce the output file name

filenameStrategy - Variable in class org.springframework.beandoc.output.XslTransformer

filterByPrefix(Map, String) - Static method in class org.springframework.beandoc.util.BeanDocUtils

Returns a new Map containing only those entries from map whose key starts with prefix.

filterByPrefix(Map, String, boolean) - Static method in class org.springframework.beandoc.util.BeanDocUtils

Returns a new Map containing only those entries from map whose key starts with prefix.

G

getBeanShape() - Method in class org.springframework.beandoc.output.GraphVizDecorator

Default shape used to describe bean nodes on the graph.

getColourBeans() - Method in class org.springframework.beandoc.output.GraphVizDecorator

Returns a Map keyed by bean name or class name that is used to determine the fill colour for bean descriptions in the HTML output andf on the graphing output.

getCompilers() - Method in class org.springframework.beandoc.DefaultContextProcessor

getCssUrl() - Method in class org.springframework.beandoc.output.HtmlDecorator

An URI (absolute or relative) that will be added toi the HTML output as a <link rel="stylesheet"> tag in the header.

getDecorators() - Method in class org.springframework.beandoc.DefaultContextProcessor

getDefaultFillColour() - Method in class org.springframework.beandoc.output.GraphVizDecorator

Fill colour used for beans on graphs and keyed in the HTML documentation if no other colour is specified through pattern matching.

getDotExe() - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

Location of the GraphViz 'dot' executable program on the local machine

getDotFileMapFormat() - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

getFileName(String) - Method in class org.springframework.beandoc.output.FilenameAppenderStrategy

getFilenameRoot() - Method in class org.springframework.beandoc.output.ConsolidatedTransformer

getFontName() - Method in class org.springframework.beandoc.output.GraphVizDecorator

The font name used on the graph nodes.

getFontSize() - Method in class org.springframework.beandoc.output.GraphVizDecorator

Font size (pt) used for node labels on graph output

getGraphXSize() - Method in class org.springframework.beandoc.output.GraphVizDecorator

The maximum length of the x-axis of the graph in inches.

getGraphYSize() - Method in class org.springframework.beandoc.output.GraphVizDecorator

The maximum length of the y-axis of the graph in inches.

getIgnoreBeans() - Method in class org.springframework.beandoc.output.GraphVizDecorator

A List of patterns representing bean names/ids or classnames that should be excluded from the output.

getInputFiles() - Method in class org.springframework.beandoc.DefaultContextProcessor

The input resources (files, classpath resources) used as the actual inputs to the beandoc tool.

getLabelLocation() - Method in class org.springframework.beandoc.output.GraphVizDecorator

Label position denoting whether graph labels appear at the top or bottom of the graph.

getLocations() - Method in class org.springframework.beandoc.output.JavaDocDecorator

A SortedMap keyed by package prefixes that point to URI's (local, remote, absolute or relative) of JavaDoc locations.

getMergeProxies() - Method in class org.springframework.beandoc.DefaultContextProcessor

getObject() - Method in class org.springframework.beandoc.util.LocalizedDateFactoryBean

Returns the formatted, current Date according to the supplied or system default Locale.

getObjectType() - Method in class org.springframework.beandoc.util.LocalizedDateFactoryBean

Returns the String class.

getOutputDir() - Method in class org.springframework.beandoc.DefaultContextProcessor

The File representing an output directory that the beandoc tool will use for outputting HTML and graph images.

getOutputForDocument(String) - Method in class org.springframework.beandoc.output.ConsolidatedTransformer

Always ignore any parameter and return the consolidated file root input with the default strategy

getOutputForDocument(String) - Method in class org.springframework.beandoc.output.DotFileTransformer

Adds input files to a list for post-processing prior to returning the name of the output file.

getOutputForDocument(String) - Method in class org.springframework.beandoc.output.XslTransformer

Return the name of the output file (relative to the configured output directory) that this transformer will use to generate output to.

getOutputType() - Method in class org.springframework.beandoc.output.GraphVizDecorator

The type of output that the GraphViz 'dot' program should create from the intermediate .dot files.

getParameters(Document) - Method in class org.springframework.beandoc.output.XslTransformer

Subclasses may optionally generate and return a Map of stylesheet parameters that will be included in the transform.

getRankBeans() - Method in class org.springframework.beandoc.output.GraphVizDecorator

A list of patterns of bean names or package names that determine how groups of similar beans are graphed.

getRatio() - Method in class org.springframework.beandoc.output.GraphVizDecorator

A value denoting ratio of x and y axes on the graoh output.

getRelativePath(String) - Static method in class org.springframework.beandoc.util.BeanDocUtils

Return a String denoting a relative path marker for the input file name (String).

getResources(String[]) - Static method in class org.springframework.beandoc.util.BeanDocUtils

Convert string values to physical resources

getStaticParameters() - Method in class org.springframework.beandoc.output.XslTransformer

getTemplateName() - Method in class org.springframework.beandoc.output.XslTransformer

The String value representing the resource pointing to an XSL stylesheet used in generating documentation output.

getTitle() - Method in class org.springframework.beandoc.output.HtmlDecorator

Title of the application context.

getTransformers() - Method in class org.springframework.beandoc.DefaultContextProcessor

GraphVizDecorator - Class in org.springframework.beandoc.output

GraphVizDecorator is a configurable Decorator implementation that adds attributes to the DOM used by DotFileTransformer in generating input files for GraphViz.

GraphVizDecorator() - Constructor for class org.springframework.beandoc.output.GraphVizDecorator

H

handleTransform(Document[], File) - Method in class org.springframework.beandoc.output.ConsolidatedTransformer

Override default behaviour to provide a single transformation of the consolidated DOM created.

handleTransform(Document[], File) - Method in class org.springframework.beandoc.output.XslTransformer

Creates an output file in the specified location for each supplied document re-using the same compiled stylesheet for each.

HtmlDecorator - Class in org.springframework.beandoc.output

HtmlDecorator decorates the DOM's with attributes used predominantly in the generation of HTML documentation.

HtmlDecorator() - Constructor for class org.springframework.beandoc.output.HtmlDecorator

I

initTransform(Document[], File) - Method in class org.springframework.beandoc.output.ConsolidatedTransformer

Generates a single Document from the array of input Documents and stores the reference for later use.

initTransform(Document[], File) - Method in class org.springframework.beandoc.output.DotFileTransformer

Stores references to the context documents and output directory which it later uses to build a consolidated graph.

initTransform(Document[], File) - Method in class org.springframework.beandoc.output.XslTransformer

Perform any initialization or one-off tasks prior to the actual transformation of the context documents with the configured stylesheet.

InvalidTransformerException - Exception in org.springframework.beandoc.output

InvalidTransformerException(String, Exception) - Constructor for exception org.springframework.beandoc.output.InvalidTransformerException

isRemoveDotFiles() - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

Should intermediate .dot files be removed?

isSingleton() - Method in class org.springframework.beandoc.util.LocalizedDateFactoryBean

A new instance of the managed object has the current date and time formatted according to the supplied Locale (or system default locale if none was specified).

isValidateFiles() - Method in class org.springframework.beandoc.DefaultContextProcessor

Input files can optionally be validated against a DTD in the XML file.

J

JavaDocDecorator - Class in org.springframework.beandoc.output

Decorator implementation that adds JavaDoc href's to beans based on their classes.

JavaDocDecorator() - Constructor for class org.springframework.beandoc.output.JavaDocDecorator

Default constructor adds well know locations to the JavaDoc location Map which can be used by a Transformer.

L

listFilesRecursively(File, FileFilter) - Static method in class org.springframework.beandoc.util.BeanDocUtils

Returns a List of File objects based on criteria specified.

LocalizedDateFactoryBean - Class in org.springframework.beandoc.util

Manages a DateFormat instance that can be customized with a given Locale.

LocalizedDateFactoryBean() - Constructor for class org.springframework.beandoc.util.LocalizedDateFactoryBean

logger - Variable in class org.springframework.beandoc.client.AntTask

logger - Variable in class org.springframework.beandoc.output.DocumentCompilerImpl

logger - Variable in class org.springframework.beandoc.output.SimpleDecorator

logger - Variable in class org.springframework.beandoc.output.XslTransformer

M

main(String[]) - Static method in class org.springframework.beandoc.client.BeanDocClient

Default boot strapper for the beandoc client.

MatchedPatternCallback - Interface in org.springframework.beandoc.util

Callback interface to be implemented by clients of the PatternMatcher class.

matchPatterns(Pattern[], String[], MatchedPatternCallback) - Static method in class org.springframework.beandoc.util.PatternMatcher

Takes an array of Patterns, the id/name and f.q.class name of a bean and a callback interface.

N

normaliseFileNames(Resource[]) - Static method in class org.springframework.beandoc.util.BeanDocUtils

For the given array of Resources, return an equivalent length array of filenames that uniquely identify each file-system resource from the shortest possible common root.

O

org.springframework.beandoc - package org.springframework.beandoc

Main package for the beandoc tool.

org.springframework.beandoc.client - package org.springframework.beandoc.client

The client package holds classes that interface the beandoc tool.

org.springframework.beandoc.output - package org.springframework.beandoc.output

The output package holds classes used to actually generate beandoc documentation (usually HTML) and where appropriate, .dot files that the graphing engine will use to draw the graphs.

org.springframework.beandoc.util - package org.springframework.beandoc.util

The util package holds classes with utility functions for the BeanDoc code.

P

patternMatched(String, int) - Method in interface org.springframework.beandoc.util.MatchedPatternCallback

Called for each matching pattern in an array

PatternMatcher - Class in org.springframework.beandoc.util

Utility class that matches bean names/id's or class names against an array of regex Patterns, using a callback interface for each pattern in the array which matched.

PatternMatcher() - Constructor for class org.springframework.beandoc.util.PatternMatcher

postTransform() - Method in class org.springframework.beandoc.output.DotFileTransformer

Generate a consolidated graph of the entire context using the same stylesheet reference provided on construction.

postTransform() - Method in class org.springframework.beandoc.output.XslTransformer

Perform any finalization or one-off tasks after the actual transformation of the context documents with the configured stylesheet.

process() - Method in interface org.springframework.beandoc.ContextProcessor

Responsible for taking configured inputs and generating all required beandoc output in whatever format has been requested.

process() - Method in class org.springframework.beandoc.DefaultContextProcessor

Handles each input file in turn, parsing the XML (which must validate against the DTD unless validation has been turned off (see DefaultContextProcessor.setValidateFiles(boolean)) creating an array of in-memory DOM documents of all input files.

S

setAttribute(Element, String, String) - Static method in class org.springframework.beandoc.DefaultContextProcessor

setBeandocContext(String) - Method in class org.springframework.beandoc.client.AntTask

Power users may wish to completely customise beandoc setup through a different context definition file.

setBeandocProps(File) - Method in class org.springframework.beandoc.client.AntTask

Specify the location of the required properties file used to configure the beandoc tool.

setBeandocPropsPrefix(String) - Method in class org.springframework.beandoc.client.AntTask

Specify a prefix for relevant properties.

setBeanShape(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

The shape to draw bean nodes in.

setColourBeans(Map) - Method in class org.springframework.beandoc.output.GraphVizDecorator

A Map keyed by bean names/ids or classnames that hold colour attributes used to fill graph nodes or key the HTML output.

setCompilers(List) - Method in class org.springframework.beandoc.DefaultContextProcessor

setCssUrl(String) - Method in class org.springframework.beandoc.output.HtmlDecorator

Optional location of a CSS file that can be used to skin the beandoc output.

setDecorators(List) - Method in class org.springframework.beandoc.DefaultContextProcessor

setDefaultFillColour(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Sets the fill colour used for beans on graphs and keyed in the HTML documentation if no other colour is specified through pattern matching.

setDotExe(String) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

Set the location of the 'dot' executable file from the Graphviz installation.

setDotFileExtension(String) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

sets the file extension of Graphviz 'dot' files.

setDotFileMapFormat(String) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

The image map format that Dot should use to generate an image map for the context graphs.

setFilenameRoot(String) - Method in class org.springframework.beandoc.output.ConsolidatedTransformer

setFilenameStrategy(FilenameStrategy) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

set a filename strategy for output files generated by this class

setFilenameStrategy(FilenameStrategy) - Method in class org.springframework.beandoc.output.HtmlDecorator

sets the filename resolution strategy to use for this decorator

setFilenameStrategy(FilenameStrategy) - Method in class org.springframework.beandoc.output.XslTransformer

set the output filename strategy to use.

setFilter(ElementFilter) - Method in class org.springframework.beandoc.output.SimpleDecorator

Directly specify a Filter to limit the Elements from the DOM that this instance will iterate over when permitting decoration.

setFilterNames(String[]) - Method in class org.springframework.beandoc.output.SimpleDecorator

Specify an array of tag names that define Elements this instance will iterate over.

setFontName(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Set the font used in bean labels in graphing output.

setFontSize(int) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Set the font size used in bean labels in graphing output.

setFooter(String) - Method in class org.springframework.beandoc.output.HtmlDecorator

Set a footer for each page which can contain HTML tags.

setGraphXSize(float) - Method in class org.springframework.beandoc.output.GraphVizDecorator

The maximum length of the x-axis of the graph in inches.

setGraphYSize(float) - Method in class org.springframework.beandoc.output.GraphVizDecorator

The maximum length of the y-axis of the graph in inches.

setIgnoreBeans(List) - Method in class org.springframework.beandoc.output.GraphVizDecorator

A List of patterns representing bean names/ids or classnames that should be excluded from the output documents.

setIncludeGraphs(boolean) - Method in class org.springframework.beandoc.output.HtmlDecorator

Set to false if you wish the HTML documentation not to include images and links to graphing output.

setInputFiles(String) - Method in class org.springframework.beandoc.client.AntTask

Deprecated. use one or more nested FileSet's instead.

setLabelLocation(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Determines whether graph titles will appear at the top or bottom of the graph.

setLocale(Locale) - Method in class org.springframework.beandoc.output.XslTransformer

Override the system default locale and specify which locale output should be generated for.

setLocale(Locale) - Method in class org.springframework.beandoc.util.LocalizedDateFactoryBean

Set the Locale to use for the managed DateFormat, overriding the system default locale.

setLocations(SortedMap) - Method in class org.springframework.beandoc.output.JavaDocDecorator

A SortedMap keyed by package prefixes that point to URI's (local, remote, absolute or relative) of JavaDoc locations.

setMergeProxies(Map) - Method in class org.springframework.beandoc.DefaultContextProcessor

Permits selective merging of ProxyFactory beans and their targets where the targets are defined as top level (referenceable) beans rather than inner beans.

setOutputDir(File) - Method in class org.springframework.beandoc.client.AntTask

Overrides any System or beandoc property to provide a direct value for output directory for the beandoc tool.

setOutputType(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Determines the format of the graphing output.

setPrettyPrint(boolean) - Method in class org.springframework.beandoc.output.EchoTransformer

The default processor removes all comments and whitespcace by default for efficiency.

setRankBeans(List) - Method in class org.springframework.beandoc.output.GraphVizDecorator

A list of patterns of bean names or package names that determine how groups of similar beans are graphed.

setRatio(String) - Method in class org.springframework.beandoc.output.GraphVizDecorator

Sets the graph ratio.

setRemoveDotFiles(boolean) - Method in class org.springframework.beandoc.output.DocumentCompilerImpl

A series of intermediate files (.dot files) are created which is what GraphViz uses to actually generate the graphs.

setSpringNamespace(Element, boolean) - Static method in class org.springframework.beandoc.DefaultContextProcessor

setStaticParameters(Map) - Method in class org.springframework.beandoc.output.XslTransformer

Provide a Map of XSL parameter values for this class that can be used to make up all or part of the Map of actual parameters used in the stylesheet.

setTemplateName(String) - Method in class org.springframework.beandoc.output.XslTransformer

loads and compile the stylesheet used in generating document output.

setTitle(String) - Method in class org.springframework.beandoc.client.AntTask

Define a title to be used in the output documentation (principally the HTML)

setTitle(String) - Method in class org.springframework.beandoc.output.HtmlDecorator

Sets the page titles for the documentation output.

setTransformers(List) - Method in class org.springframework.beandoc.DefaultContextProcessor

Set a List of Transformers.

setValidateFiles(boolean) - Method in class org.springframework.beandoc.DefaultContextProcessor

Set to false to prevent the XML parser validating input files against a DTD.

setWriter(Writer) - Method in class org.springframework.beandoc.output.EchoTransformer

Set the Writer that you wish output to be directed to.

SimpleDecorator - Class in org.springframework.beandoc.output

Abstract implementation of the Decorator interface which simply iterates each Element in each Document and calls the protected decorateElement method that subclasses will implement.

SimpleDecorator() - Constructor for class org.springframework.beandoc.output.SimpleDecorator

SPRING_2_0_NAMESPACE - Static variable in class org.springframework.beandoc.DefaultContextProcessor

staticParameters - Variable in class org.springframework.beandoc.output.XslTransformer

T

TAGNAME_BEAN - Static variable in class org.springframework.beandoc.Tags

TAGNAME_BEANS - Static variable in class org.springframework.beandoc.Tags

TAGNAME_CONSTRUCTOR_ARG - Static variable in class org.springframework.beandoc.Tags

TAGNAME_DESCRIPTION - Static variable in class org.springframework.beandoc.Tags

TAGNAME_ENTRY - Static variable in class org.springframework.beandoc.Tags

TAGNAME_IDREF - Static variable in class org.springframework.beandoc.Tags

TAGNAME_IMPORT - Static variable in class org.springframework.beandoc.Tags

TAGNAME_LOOKUP - Static variable in class org.springframework.beandoc.Tags

TAGNAME_PROPERTY - Static variable in class org.springframework.beandoc.Tags

TAGNAME_REF - Static variable in class org.springframework.beandoc.Tags

TAGNAME_REPLACE - Static variable in class org.springframework.beandoc.Tags

Tags - Class in org.springframework.beandoc

Specifies common constants such as tag and attribute names from both Spring's DTD and beandoc's decorator model.

Tags() - Constructor for class org.springframework.beandoc.Tags

transform(Document[], File) - Method in class org.springframework.beandoc.output.CsvTransformer

create a new CSV file for each context file

transform(Document[], File) - Method in class org.springframework.beandoc.output.EchoTransformer

Simply echoes a textual representation of the decorated JDOM documents to the configured Writer (or System.out if no other was specified).

transform(Document[], File) - Method in interface org.springframework.beandoc.output.Transformer

Process the context document array to output the bean documentation in the required format.

transform(Document[], File) - Method in class org.springframework.beandoc.output.XslTransformer

Implements the Transformer API and sanity checks some configuration aspects before beginning the transformation workflow.

Transformer - Interface in org.springframework.beandoc.output

Transformer implementations do the work of generating output based on the decorated Documents passed to them.

X

XslTransformer - Class in org.springframework.beandoc.output

Base implementation of the Transformer interface that uses XSLT (via TRaX) in order to generate output files.

XslTransformer() - Constructor for class org.springframework.beandoc.output.XslTransformer

default constructor

XslTransformer(String) - Constructor for class org.springframework.beandoc.output.XslTransformer

loads and compiles the stylesheets using specified values.

A B C D E F G H I J L M N O P S T X