XDC - v. 0.6.1
A C D E F G H I L M N P R S T X

A

accept(File, String) - Method in class net.sf.xdc.util.PathDescriptor
This is an implementation of the method defined in the FilenameFilter interface.
addBottom(Javadoc.Html) - Method in class net.sf.xdc.XdcTask
Alternative setter method for this XdcTask's bottom attribute.
addDoctitle(Javadoc.Html) - Method in class net.sf.xdc.XdcTask
Alternative setter method for this XdcTask's doctitle attribute.
addFooter(Javadoc.Html) - Method in class net.sf.xdc.XdcTask
Alternative setter method for this XdcTask's footer attribute.
addHeader(Javadoc.Html) - Method in class net.sf.xdc.XdcTask
Alternative setter method for this XdcTask's header attribute.
addPattern(XPathPattern) - Method in class net.sf.xdc.processing.XdcSource
This method stores an XPathPattern (corresponding to a link with an XPath expression anchor) in this XdcSource.
addSource(XdcSource) - Method in class net.sf.xdc.processing.XdcPackage
This method is used to register an XdcSource with this XdcPackage.

C

ClasspathURLConnection - class net.sf.xdc.util.ClasspathURLConnection.
This class contains all functionality required for processing URLs with the classpath protocol.
ClasspathURLConnection.StreamHandlerFactory - class net.sf.xdc.util.ClasspathURLConnection.StreamHandlerFactory.
This (inner) class is a factory class which produces a suitable URLStreamHandler object which is capable of dealing with the classpath protocol.
ClasspathURLConnection.StreamHandlerFactory() - Constructor for class net.sf.xdc.util.ClasspathURLConnection.StreamHandlerFactory
 
clearProcessingProperties(Properties) - Static method in class net.sf.xdc.processing.XdcSource
This method clears all file specific key-value pairs set in XdcSource.setProcessingProperties(Properties, String, String).
compareTo(Object) - Method in class net.sf.xdc.processing.XdcSource
This method compares this XdcSource with another one by
(1) their file names and
(2) the names of their respective packages.
connect() - Method in class net.sf.xdc.util.ClasspathURLConnection
This method opens a the parent URL's connection.
convert(String) - Static method in class net.sf.xdc.util.PathDescriptor
This utility method is used to convert an expression containing "basic" wildcards like "?"
copy(InputStream, OutputStream) - Static method in class net.sf.xdc.util.IOUtils
Reads byte data in chunks of a specified size from one stream and writes it into another stream.
copy(Reader, Writer) - Static method in class net.sf.xdc.util.IOUtils
Reads character data in chunks of a specified size from a Reader and writes it into a Writer.
copyTree(File, File) - Static method in class net.sf.xdc.util.IOUtils
This method is used to recursively copy the contents of one complete directory tree from one location in the file system to another.
createArg() - Method in class net.sf.xdc.XdcTask
Getter method for a new argument to be passed to this XdcTask.
createClasspath() - Method in class net.sf.xdc.XdcTask
Getter method for this XdcTask's classpath.
createDocument() - Static method in class net.sf.xdc.util.XmlUtils
This method creates a new DOM document.
createJvmarg() - Method in class net.sf.xdc.XdcTask
Getter method for a new Java VM argument to be passed to this XdcTask.
createSourcepath() - Method in class net.sf.xdc.XdcTask
Getter method for this XdcTask's source path.
createURLStreamHandler(String) - Method in class net.sf.xdc.util.ClasspathURLConnection.StreamHandlerFactory
This method creates a URLStreamHandler for the classpath protocol.

D

DialectHandler - class net.sf.xdc.processing.DialectHandler.
This class is used for determining the XML dialect of an input XML file in order to be able to apply the correct XSLT stylesheet to the input file.
DialectHandler(String, String) - Constructor for class net.sf.xdc.processing.DialectHandler
Protected constructor.

E

equals(Object) - Method in class net.sf.xdc.processing.XdcSource
This method determines whether this XdcSource is equal to another such object by comparing their respective File objects.
execute() - Method in class net.sf.xdc.XdcTask
This method executes this XdcTask.
execute(XdcSource) - Method in interface net.sf.xdc.processing.FileAction
The execute method is used to either include or exclude a potential XML source file from the XDC tool.

F

FileAction - interface net.sf.xdc.processing.FileAction.
This class is used in the process of assembling the set of source files to which the XDC application is to be applied.
FileSelector - class net.sf.xdc.processing.FileSelector.
The FileSelector class allows to specify which files within a directory are to be included in the XDC processing.
FileTokenizer - class net.sf.xdc.util.FileTokenizer.
A FileTokenizer is used to parse an options file for the XDC tool (which is specified with the '@' notation as a command line argument).
FileTokenizer(File) - Constructor for class net.sf.xdc.util.FileTokenizer
Public constructor.
flatten(Options, String[], boolean) - Method in class net.sf.xdc.XdcParser
 

G

getChildDescriptor() - Method in class net.sf.xdc.util.PathDescriptor
If the path used for construction of this PathDescriptor consists of more than one constituent, this method can be used to retrieve a child descriptor corresponding to the sub-path after the first constituent.
getContents() - Method in class net.sf.xdc.util.FileTokenizer
This method does the actual parsing of the XDC options file.
getDialectHandler(File, String, CommandLine) - Static method in class net.sf.xdc.processing.DialectHandler
Static getter method for the correct DialectHandler object.
getDialectHandler() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's DialectHandler object.
getDir() - Method in class net.sf.xdc.processing.FileSelector
Getter method for this FileSelector's directory.
getFile() - Method in class net.sf.xdc.processing.XPathPattern
Getter method for this XPathPattern's file value (i.e. the constituent of the link before the double hash ('##')).
getFile() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's File object.
getFileName() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's output file name.
getFramesetSize() - Method in class net.sf.xdc.processing.XdcSourceCollector
This method is used to determine the number of frames contained in the main frameset of the generated XDC documentation.
getInputStream() - Method in class net.sf.xdc.util.ClasspathURLConnection
This method retrieves the InputStream of the parent URL.
getLeadingSourcePath() - Method in class net.sf.xdc.processing.XdcSourceCollector
This method returns the directory specified as the first argument of the -sourcepath option.
getLink(Element) - Static method in class net.sf.xdc.util.XmlUtils
This method is the Java equivalent to the template with mode="util.getLink" defined in the util.xsl stylesheet.
getLogger() - Static method in class net.sf.xdc.util.Logging
This method returns a Log4J Logger with a name equal to the class from which this method is invoked.
getName() - Method in class net.sf.xdc.processing.DialectHandler
Getter method for this DialectHandler's name.
getName() - Method in class net.sf.xdc.processing.XdcPackage
Getter method for this XdcPackage's name.
getOpt() - Method in class net.sf.xdc.processing.XdcOption
 
getOption(String) - Method in class net.sf.xdc.processing.XdcOptions
This method retrieves an available XDC option by its name.
getOptionProperties(CommandLine) - Method in class net.sf.xdc.processing.XdcOptions
This method is used to convert all available XDC options for which a value has been set on the command line into a Properties object.
getPackageName() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's package name.
getPackageNames() - Method in class net.sf.xdc.processing.XdcSourceCollector
This method returns an array of the names of all packages containing XML source files specified for processing.
getPattern() - Method in class net.sf.xdc.processing.XPathPattern
Getter method for this XPathPattern's pattern (i.e. the constituent of the link after the double hash ('##')).
getPatterns() - Method in class net.sf.xdc.processing.XdcSource
This method retrieves all XPathPattern objects stored in this XdcSource in the form of a Properties object (where the links in the source file make up the keys and the XPathPattern values make up the values).
getReader(File, Charset) - Static method in class net.sf.xdc.util.IOUtils
This method constructs a Reader object of a File for a given Charset.
getReader(String, Charset) - Static method in class net.sf.xdc.util.IOUtils
This method constructs a Reader object of a File for a given Charset.
getRootComment() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's root comment String.
getSourceDir() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's source directory.
getSourceFileName() - Method in class net.sf.xdc.processing.XdcSource
Getter method for this XdcSource's source file name.
getSummaryText() - Method in class net.sf.xdc.processing.XdcPackage
This method retrieves the relevant package summary file text.
getSummaryText() - Method in class net.sf.xdc.processing.XdcSourceCollector
This method attempts to extract text from an overview file (which is specified by the -overview option and must be placed in of the root directories specified as arguments to the -sourcepath options).
getTargetFile() - Method in class net.sf.xdc.processing.XPathPattern
Getter method for this XPathPattern's targetFile member.
getTextValue(Node) - Static method in class net.sf.xdc.util.XmlUtils
This utility method retrieves the text value from a DOM Node.
getValue() - Method in class net.sf.xdc.processing.XPathPattern
Getter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).
getWriter(File, Charset) - Static method in class net.sf.xdc.util.IOUtils
This method constructs a Writer object of a File for a given Charset.
getWriter(String, Charset) - Static method in class net.sf.xdc.util.IOUtils
This method constructs a Writer object of a File for a given Charset.
getXdcOptions() - Static method in class net.sf.xdc.processing.XdcOptions
Static getter method for the (single) instance of the XdcOptions class.
getXdcPackage(String) - Method in class net.sf.xdc.processing.XdcSourceCollector
This method retrieves an XdcPackage object specified for processing by the XDC tool.
getXdcSource(String) - Method in class net.sf.xdc.processing.XdcPackage
This method retrieves a particular XdcSource object from this XdcPackage by its (non-qualified) name.
getXdcSource(String) - Method in class net.sf.xdc.processing.XdcSourceCollector
This method retrieves a particular XdcSource by its (fully-qualified) source name.
getXdcSources() - Method in class net.sf.xdc.processing.XdcPackage
This method retrieves all registered XdcSource objects.
getXdcSources() - Method in class net.sf.xdc.processing.XdcSourceCollector
This getter method retrieves all assembled XML source files.
getXdcSources(String) - Method in class net.sf.xdc.processing.XdcSourceCollector
This method retrieves all XdcSource objects contained in an XdcPackage.
getXslResourcePath() - Method in class net.sf.xdc.processing.DialectHandler
Getter method for this DialectHandler's resource path.

H

hasOption(String) - Method in class net.sf.xdc.processing.XdcOptions
This method determines whether an option with a certain name is available.
hashCode() - Method in class net.sf.xdc.processing.XdcSource
This method delegates to the hashCode() method of this XdcSource's File object.

I

IOUtils - class net.sf.xdc.util.IOUtils.
This utility class contains a number of useful static methods related to Stream manipulation.
isDefaultExclude(String) - Static method in class net.sf.xdc.util.IOUtils
This method is used to determine whether a path constituent should be excluded from processing because it is most likely a directory or file containing version control information.
isXslParam() - Method in class net.sf.xdc.processing.XdcOption
Getter method for this XdcOption's xslParam field which determines whether or not this command line option is passed to the processing XSLT stylesheet via a stylesheet parameter.

L

Logging - class net.sf.xdc.util.Logging.
The Logging class is a utility class wrapping the access to the Apache Log4J logging library.

M

Main - class net.sf.xdc.Main.
This class provides the main entry point for the XDC application.
main(String[]) - Static method in class net.sf.xdc.Main
This is the main entry point for the XDC application.
makeEmpty(File) - Static method in class net.sf.xdc.util.IOUtils
This method is used to completely delete all contents of a directory including all files and (recursively) subdirectories, but not the (specified) directory itself.
matches(File) - Method in class net.sf.xdc.util.PathDescriptor
This method determines whether a String matches the pattern expressed by the first constituent of the path used for construction of this PathDescriptor.
matchesDirWithWildcard(File) - Method in class net.sf.xdc.util.PathDescriptor
This method determines whether a file is a directory and the path pattern of this PathDescriptor is the path wildcard pattern ("**").
moveToSubdir(String) - Method in class net.sf.xdc.processing.FileSelector
This method constructs a FileSelector for a subdirectory of the current directory.
moveToSubdir(String) - Method in class net.sf.xdc.processing.PatternSelector
This method constructs a PatternSelector for a subdirectory of the current directory.

N

net.sf.xdc - package net.sf.xdc
 
net.sf.xdc.processing - package net.sf.xdc.processing
 
net.sf.xdc.util - package net.sf.xdc.util
 

P

PathDescriptor - class net.sf.xdc.util.PathDescriptor.
This class implements the FilenameFilter interface and is used to filter out files from a list of files contained in a directory.
PathDescriptor(String, boolean) - Constructor for class net.sf.xdc.util.PathDescriptor
Public constructor.
PatternSelector - class net.sf.xdc.processing.PatternSelector.
The PatternSelector class is an extension to the FileSelector class which allows to additionally restrict the set of selected files by specifying one or more PathDescriptors (wildcard expressions).
parse(InputStream) - Static method in class net.sf.xdc.util.XmlUtils
This method creates an XML document from the contents of an InputStream.
printHtml(Writer, Document) - Static method in class net.sf.xdc.util.XmlUtils
This method streams an XML document with method="html" into a Writer object.
printXml(Writer, Document) - Static method in class net.sf.xdc.util.XmlUtils
This method streams an XML document with method="xml" into a Writer object.
process() - Method in class net.sf.xdc.processing.XdcProcessor
This method generates all files for the XDC documentation pages.
processSource(XdcSource, Charset, Charset) - Method in class net.sf.xdc.processing.SourceProcessor
This method is responsible for generating the HTML version of the source file specified by the source parameter.
processingInstructionIO(String, String) - Method in class net.sf.xdc.util.XdcSerializer
This method adds support for the "disable-output-escaping" processing instruction.

R

removeSource(XdcSource) - Method in class net.sf.xdc.processing.XdcPackage
This method is used to unregister an XdcSource from this XdcPackage.

S

SourceProcessor - class net.sf.xdc.processing.SourceProcessor.
This class is responsible for generating HTML pages containing the contents of XML source files (in HTML format), decorated with line numbers and named anchors (enumerated by the current line numbers).
SourceProcessor(File) - Constructor for class net.sf.xdc.processing.SourceProcessor
Public constructor.
selectFiles() - Method in class net.sf.xdc.processing.FileSelector
This method retrieves the collection of all selected files within this FileSelector's directory.
selectFiles() - Method in class net.sf.xdc.processing.PatternSelector
This method retrieves the collection of all selected files within this PatternSelector's directory which match the wildcard expression of one or more of its PathDescriptor objects.
selectNode(Node, String) - Static method in class net.sf.xdc.util.XPathUtils
This method retrieves the single subnode of the given DOM Node which satisfies the specified XPath pattern.
selectNodes(Node, String) - Static method in class net.sf.xdc.util.XPathUtils
This method retrieves a NodeIterator which iterates over all subnodes of a given DOM node satisfying the specified XPath pattern.
setAuthor(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's author attribute.
setBottom(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's bottom attribute.
setCharset(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's charset attribute.
setClasspath(Path) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's classpath.
setClasspathRef(Reference) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's classpathref.
setDefaultexcludes(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's defaultexcludes attribute.
setDestdir(File) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's destination directory.
setDialect(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's dialect attribute.
setDialectmapping(File) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's dialectmapping attribute.
setDialects(File) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's dialects attribute.
setDocencoding(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's docencoding attribute.
setDoctitle(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's doctitle attribute.
setEncoding(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's encoding attribute.
setExtensions(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's extensions attribute.
setFooter(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's footer attribute.
setHeader(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's header attribute.
setHelpfile(File) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's helpfile attribute.
setLinksource(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's linksource attribute.
setLocale(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's locale attribute.
setNosince(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's nosince attribute.
setNotimestamp(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's notimestamp attribute.
setOverview(File) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's overview attribute.
setProcessingProperties(Properties, String, String) - Method in class net.sf.xdc.processing.XdcSource
This method is used to set file specific properties in a given Properties object.
setReportmissing(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's reportmissing attribute.
setRootComment(String) - Method in class net.sf.xdc.processing.XdcSource
Setter method for this XdcSource's root comment String.
setSourcepath(Path) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's source path.
setSourcepathRef(Reference) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's source path reference.
setSubpackages(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's subpackages attribute.
setTargetFile(String) - Method in class net.sf.xdc.processing.XPathPattern
Setter method for this XPathPattern's targetFile member.
setValue(String) - Method in class net.sf.xdc.processing.XPathPattern
Setter method for this XPathPattern's value (i.e. the name of the anchor of the targetted element in the generated documentation page).
setVersion(boolean) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's version attribute.
setWindowtitle(String) - Method in class net.sf.xdc.XdcTask
Setter method for this XdcTask's windowtitle attribute.

T

transform(String, Charset, String, Map) - Static method in class net.sf.xdc.util.XslUtils
This method attempts to transform an XML structure contained in a file using an XSLT stylesheet contained in a resource (which can be loaded by the Classloader of this class) into a DOM Document.
transform(Document, String, Map) - Static method in class net.sf.xdc.util.XslUtils
This method attempts to transform an XML structure contained in a DOM Document using an XSLT stylesheet contained in a resource (which can be loaded by the Classloader of this class) into a DOM Document.
transformToString(String, String, Map) - Static method in class net.sf.xdc.util.XslUtils
This method attempts to transform an XML structure contained in a file using an XSLT stylesheet contained in a resource (which can be loaded by the Classloader of this class) into a String.

X

XPathPattern - class net.sf.xdc.processing.XPathPattern.
The class XPathPattern represents a link within a {@link} or a @see tag whose anchor section is an XPath expression.
XPathPattern(String, String) - Constructor for class net.sf.xdc.processing.XPathPattern
Public constructor.
XPathUtils - class net.sf.xdc.util.XPathUtils.
The XPathUtils class contains a few utility methods used for selecting subnodes from a DOM node by an XPath expression.
XdcOption - class net.sf.xdc.processing.XdcOption.
This class represents a command line option of the XDC application.
XdcOption(String, String, boolean) - Constructor for class net.sf.xdc.processing.XdcOption
Public constructor.
XdcOption(String, String, String, boolean) - Constructor for class net.sf.xdc.processing.XdcOption
Public constructor.
XdcOptions - class net.sf.xdc.processing.XdcOptions.
This class is responsible for setting up all available command line options for the XDC tool.
XdcPackage - class net.sf.xdc.processing.XdcPackage.
This class represents a "package" of sources.
XdcPackage(String) - Constructor for class net.sf.xdc.processing.XdcPackage
Public constructor.
XdcParser - class net.sf.xdc.XdcParser.
This class provides a command line parser which mainly differs from its parent, BasicParser, in the fact that it resolves paths to files containing additional command line options ('@' notation).
XdcParser() - Constructor for class net.sf.xdc.XdcParser
 
XdcProcessor - class net.sf.xdc.processing.XdcProcessor.
This class is responsible for processing all source files by applying the appropriate stylesheets to the sources specified during the invocation of the XDC tool.
XdcProcessor(CommandLine) - Constructor for class net.sf.xdc.processing.XdcProcessor
This public constructor uses the command line to collect all necessary sources for processing.
XdcSerializer - class net.sf.xdc.util.XdcSerializer.
This class is used to serialize an HTML document to a stream.
XdcSerializer(Writer, OutputFormat) - Constructor for class net.sf.xdc.util.XdcSerializer
Public constructor.
XdcSource - class net.sf.xdc.processing.XdcSource.
This class represents an XML source file which is to be processed by the XDC tool.
XdcSource(File, File, String, DialectHandler) - Constructor for class net.sf.xdc.processing.XdcSource
Public constructor.
XdcSourceCollector - class net.sf.xdc.processing.XdcSourceCollector.
The XdcSourceCollector class is used to assemble the possible XML source files specified for processing into XDC documentation.
XdcSourceCollector(CommandLine) - Constructor for class net.sf.xdc.processing.XdcSourceCollector
Public constructor.
XdcTask - class net.sf.xdc.XdcTask.
The XdcTask is a task for the Apache Ant build system.
XdcTask() - Constructor for class net.sf.xdc.XdcTask
 
XmlException - exception net.sf.xdc.util.XmlException.
This class implements an unspecific exception that is thrown if an exception occurs during XML processing.
XmlException(Throwable) - Constructor for class net.sf.xdc.util.XmlException
This public constructor wraps an Exception that occurs during XML processing.
XmlUtils - class net.sf.xdc.util.XmlUtils.
This is a utility class responsible for parsing and printing XML documents.
XslUtils - class net.sf.xdc.util.XslUtils.
This is a utility class containg various method related to XSLT transformations.

A C D E F G H I L M N P R S T X
XDC - v. 0.6.1