A B C D E F G H I J L M N P R S T V Z

A

AbstractHtmlSeeTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Base implementation that renders the see, link and linkplain tags as HTML.

AbstractHtmlSeeTagRenderer(boolean) - Constructor for class de.smartics.analysis.javadoc.render.html. AbstractHtmlSeeTagRenderer

Default constructor.

AbstractProjectClassLoader - Class in de.smartics.analysis.javadoc.runtime

Base implementation of class loaders that serve classes from the given directories.

AbstractProjectClassLoader(ClassLoader) - Constructor for class de.smartics.analysis.javadoc.runtime. AbstractProjectClassLoader

Default constructor.

AbstractScannerFactory - Class in de.smartics.analysis.javadoc.scan

Base implementation of the interface.

AbstractScannerFactory(String[], String[]) - Constructor for class de.smartics.analysis.javadoc.scan. AbstractScannerFactory

Default constructor.

accept(Doc) - Method in interface de.smartics.analysis.javadoc. Filter

Filters the given Javadoc information.

accept(Doc) - Method in class de.smartics.analysis.javadoc.filter. AcceptAllFilter

Filters the given Javadoc information.

accept(Doc) - Method in class de.smartics.analysis.javadoc.filter. ImplementsInterfaceFilter

Filters the given Javadoc information.

AcceptAllFilter - Class in de.smartics.analysis.javadoc.filter

Accepts all, rejects nothing.

AcceptAllFilter() - Constructor for class de.smartics.analysis.javadoc.filter. AcceptAllFilter

Default constructor.

addJavadocArguments(JavadocProjectConfiguration, Map<String, String>) - Static method in class de.smartics.analysis.javadoc. JavadocArgumentsUtils

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

addJavadocArguments(Log, JavadocProjectConfiguration, Map<String, String>) - Static method in class de.smartics.analysis.javadoc. JavadocArgumentsUtils

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

B

build() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Creates the project configuration.

C

capitalize(String) - Static method in class de.smartics.analysis.javadoc.util. StringFunction

This method transforms the first character to upper case and returns the result.

checkCollectionValueProvided(StringBuilder, Collection<?>, String) - Static method in class de.smartics.analysis.javadoc.conf. ConfigUtils

Checks that the Collection value is provided.

checkStringValueProvided(StringBuilder, String, String) - Static method in class de.smartics.analysis.javadoc.conf. ConfigUtils

Checks that the String value is provided.

checkValueProvided(StringBuilder, Object, String) - Static method in class de.smartics.analysis.javadoc.conf. ConfigUtils

Checks that the Object value is provided.

close() - Method in class de.smartics.analysis.javadoc. Console

Closes the streams and stores their content as message strings.

close() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageWriter

CodeTagRenderer - Interface in de.smartics.analysis.javadoc.render

Renders code tags.

collect() - Method in class de.smartics.analysis.javadoc. DefaultJavadocCollector

Runs the collector.

collect() - Method in interface de.smartics.analysis.javadoc. JavadocCollector

Runs the collector.

CollectorContext - Class in de.smartics.analysis.javadoc

The context of a collector execution.

CollectorContext(Filter, ClassLoader) - Constructor for class de.smartics.analysis.javadoc. CollectorContext

Default constructor.

CollectorContext(Filter) - Constructor for class de.smartics.analysis.javadoc. CollectorContext

Convenience constructor if no class loader needs to be specified.

CollectorContextManager - Class in de.smartics.analysis.javadoc

The singleton provides the collector context used to provide information to the collector doclet.

CollectorDoclet - Class in de.smartics.analysis.javadoc

The doclet to interface with the Javadoc tool.

configureAndScan(DirectoryScanner) - Method in class de.smartics.analysis.javadoc.scan. AbstractScannerFactory

Configures the scanner and runs the scan.

ConfigUtils - Class in de.smartics.analysis.javadoc.conf

This class provides utilities to discover source files.

Console - Class in de.smartics.analysis.javadoc

Encapsulates the information returned to the console.

Console() - Constructor for class de.smartics.analysis.javadoc. Console

Default constructor.

createCodeTagRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a renderer to handle code tags.

createCodeTagRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a renderer to handle code tags.

createConsoleMessage(String) - Method in class de.smartics.analysis.javadoc. Console

Creates a message to be printed to a console or log file.

createJavadocArguments(JavadocProjectConfiguration) - Static method in class de.smartics.analysis.javadoc. JavadocArgumentsUtils

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

createJavadocArguments(Log, JavadocProjectConfiguration) - Static method in class de.smartics.analysis.javadoc. JavadocArgumentsUtils

Maps the information from the configuration to the map of arguments that is passed to the Javadoc tool.

createLinkPlainTagRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a renderer to handle linkplain tags.

createLinkPlainTagRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a renderer to handle linkplain tags.

createLiteralTagRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a renderer to handle literal tags.

createLiteralTagRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a renderer to handle literal tags.

createPackageName(String) - Static method in class de.smartics.analysis.javadoc. FileNameUtils

Creates the package name for the given directory.

createPackageNames(Log, String, ScannerFactory) - Static method in class de.smartics.analysis.javadoc. FileNameUtils

Creates package names from directory files found by the given scanner.

createScanner(String) - Method in class de.smartics.analysis.javadoc.scan. DirectoryScannerFactory

Creates the scanner with the given root directory set.

createScanner(String) - Method in interface de.smartics.analysis.javadoc.scan. ScannerFactory

Creates the scanner with the given root directory set.

createScanner(String) - Method in class de.smartics.analysis.javadoc.scan. ZipScannerFactory

Creates the scanner with the given root directory set.

createSeeTagRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a renderer to handle see and link tags.

createSeeTagRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a renderer to handle see and link tags.

createTextRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a text renderer.

createTextRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a text renderer.

createValueTagRenderer() - Method in class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Creates a renderer to handle value tags.

createValueTagRenderer() - Method in interface de.smartics.analysis.javadoc.render. RendererFactory

Creates a renderer to handle value tags.

D

de.smartics.analysis.javadoc - package de.smartics.analysis.javadoc

Provides the interfacing classes with the Javadoc tool.

de.smartics.analysis.javadoc.conf - package de.smartics.analysis.javadoc.conf

de.smartics.analysis.javadoc.filter - package de.smartics.analysis.javadoc.filter

Provides implementations for the interface Filter and utilities for filtering.

de.smartics.analysis.javadoc.log - package de.smartics.analysis.javadoc.log

Provides classes listen to messages issued by the Javadoc tool.

de.smartics.analysis.javadoc.log.message - package de.smartics.analysis.javadoc.log.message

Provides classes to parse and contain messages issued by the Javadoc tool.

de.smartics.analysis.javadoc.render - package de.smartics.analysis.javadoc.render

de.smartics.analysis.javadoc.render.html - package de.smartics.analysis.javadoc.render.html

de.smartics.analysis.javadoc.runtime - package de.smartics.analysis.javadoc.runtime

de.smartics.analysis.javadoc.scan - package de.smartics.analysis.javadoc.scan

de.smartics.analysis.javadoc.util - package de.smartics.analysis.javadoc.util

DefaultJavadocCollector - Class in de.smartics.analysis.javadoc

The base implementation to interface with the Javadoc tool.

DefaultJavadocCollector(String, Map<String, String>, CollectorContext) - Constructor for class de.smartics.analysis.javadoc. DefaultJavadocCollector

Default constructor.

DefaultJavadocProjectConfiguration - Class in de.smartics.analysis.javadoc.conf

Default implementation.

DefaultJavadocProjectConfiguration.Builder - Class in de.smartics.analysis.javadoc.conf

The configuration builder.

DefaultJavadocProjectConfiguration.Builder(String) - Constructor for class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Default constructor.

DefaultTextRenderer - Class in de.smartics.analysis.javadoc.render

Default implementation that simply outputs the text unchanged.

DefaultTextRenderer() - Constructor for class de.smartics.analysis.javadoc.render. DefaultTextRenderer

DirectoryScannerFactory - Class in de.smartics.analysis.javadoc.scan

Creates directory scanners.

DirectoryScannerFactory(String[], String[]) - Constructor for class de.smartics.analysis.javadoc.scan. DirectoryScannerFactory

Constructor.

discoverSourceDirectory(String) - Static method in class de.smartics.analysis.javadoc.conf. ConfigUtils

Dispatches the given name and tries to find a source directory for it.

discoverSourceJars(Collection<String>) - Static method in class de.smartics.analysis.javadoc.conf. ConfigUtils

Checks each name if it references a library and if this is the case tries to find a source archive for the class archive.

E

ensurePackageProvided(String) - Method in class de.smartics.analysis.javadoc.runtime. AbstractProjectClassLoader

Ensures that the package of a class specified by the given name is already defined.

excludes - Variable in class de.smartics.analysis.javadoc.scan. AbstractScannerFactory

The excludes for the scanner.

executeJavadocParser() - Method in class de.smartics.analysis.javadoc. DefaultJavadocCollector

Runs the Javadoc tool.

executeJavadocParser(String, Map<String, String>) - Static method in class de.smartics.analysis.javadoc. JavadocUtils

Runs the Javadoc tool.

executeJavadocParser(String, String[]) - Static method in class de.smartics.analysis.javadoc. JavadocUtils

Runs the Javadoc tool.

executeJavadocParser(String, String, Map<String, String>, JavadocMessageLogger) - Static method in class de.smartics.analysis.javadoc. JavadocUtils

Runs the Javadoc tool.

F

FileNameUtils - Class in de.smartics.analysis.javadoc

Utilities to work on file names and files.

Filter - Interface in de.smartics.analysis.javadoc

A filter to remove unwanted Javadoc information from a doclet.

FilterUtils - Class in de.smartics.analysis.javadoc.filter

Provides utilities for filtering on Doc elements.

findClass(String) - Method in class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

findResource(String) - Method in class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

findResources(String) - Method in class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

flush() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageWriter

G

generateJavadocParserArguments() - Method in class de.smartics.analysis.javadoc. DefaultJavadocCollector

Flattens the arguments found in the properties to an array to be passed to the Javadoc tool.

generateJavadocParserArguments(Map<String, String>) - Static method in class de.smartics.analysis.javadoc. JavadocUtils

Flattens the arguments found in the properties to an array to be passed to the Javadoc tool.

getClassRootDirectoryNames() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the list of class path root elements of this project.

getClassRootDirectoryNames() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the list of class path root elements of this project.

getCollectorContext() - Static method in class de.smartics.analysis.javadoc. CollectorContextManager

Returns the thread-locally stored collector context.

getColumn() - Method in class de.smartics.analysis.javadoc.log.message. IssueLocation

Returns the column the issue occurs in.

getConsole() - Method in exception de.smartics.analysis.javadoc. JavadocException

Returns the information provided by the Javadoc tool via the console.

getErrMessages() - Method in class de.smartics.analysis.javadoc. Console

Returns the messages written to the error stream.

getErrMessages() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the collected error messages.

getErrWriter() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the writer to be notified about errors encountered by the Javadoc tool.

getExcludes() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the excludes for the scanner.

getExcludes() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the excludes for the scanner.

getFileName() - Method in class de.smartics.analysis.javadoc.log.message. IssueLocation

Returns the name of the file the issue is located in.

getFilter() - Method in class de.smartics.analysis.javadoc. CollectorContext

Returns the filter used by the doclet to remove found Javadoc information.

getIncludes() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the includes for the scanner.

getIncludes() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the includes for the scanner.

getJavadocArguments() - Method in class de.smartics.analysis.javadoc. DefaultJavadocCollector

Returns the arguments to pass to the Javadoc tool.

getLine() - Method in class de.smartics.analysis.javadoc.log.message. IssueLocation

Returns the line number the issue occurs in.

getLocation() - Method in class de.smartics.analysis.javadoc.log.message. IssueMessage

Returns the location of the issue.

getMessage() - Method in class de.smartics.analysis.javadoc.log.message. IssueMessage

Returns the message text of the message.

getMessages() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageWriter

Returns the messages collected.

getNoticeMessages() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the collected notice messages.

getNoticeWriter() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the writer to be notified about notices made by the Javadoc tool.

getOutMessages() - Method in class de.smartics.analysis.javadoc. Console

Returns the messages written to the output stream.

getProgramName() - Method in class de.smartics.analysis.javadoc. DefaultJavadocCollector

Returns the name of the program that runs the Javadoc collector.

getProjectClassLoader() - Method in class de.smartics.analysis.javadoc. CollectorContext

Returns the class loader to use for the Javadoc tool if not null.

getProjectClassLoader() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the class loader to load project classes.

getProjectClassLoader() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the class loader to load project classes.

getProjectName() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the name of the project being processed.

getProjectName() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the name of the project being processed.

getResult() - Method in class de.smartics.analysis.javadoc. CollectorContext

Returns the result of the collection of Javadoc information collected by the doclet.

getReturnCode() - Method in class de.smartics.analysis.javadoc. Console

Returns the return code returned by the executed program.

getReturnCode() - Method in exception de.smartics.analysis.javadoc. JavadocException

Returns the code returned by the Javadoc tool.

getReturnCode() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the return code reported by the Javadoc tool.

getSourceEncoding() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the encoding specified for the sources in the project.

getSourceEncoding() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the encoding specified for the sources in the project.

getSourceRootDirectoryNames() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the list of source path root elements of this project.

getSourceRootDirectoryNames() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the list of source path root elements of this project.

getSourceVersion() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the Java version specified for the sources in the project.

getSourceVersion() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the Java version specified for the sources in the project.

getToolClassPath() - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration

Returns the classpath used by the tool.

getToolClassPath() - Method in interface de.smartics.analysis.javadoc.conf. JavadocProjectConfiguration

Returns the class path elements to use for tools we call.

getType() - Method in class de.smartics.analysis.javadoc.filter. ImplementsInterfaceFilter

Returns the interface class to filter with.

getWarnMessages() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the collected warn messages.

getWarnWriter() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the writer to be notified about warnings encountered by the Javadoc tool.

H

hasMessages(boolean) - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Checks if there are messages logged.

HtmlCodeTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Default implementation that renders the code tag as HTML.

HtmlCodeTagRenderer() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlCodeTagRenderer

HtmlLinkPlainTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Default implementation that renders the linkplain tags as HTML.

HtmlLinkPlainTagRenderer() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlLinkPlainTagRenderer

Default constructor.

HtmlLiteralTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Default implementation that renders the literal tag as HTML.

HtmlLiteralTagRenderer() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlLiteralTagRenderer

HtmlRendererFactory - Class in de.smartics.analysis.javadoc.render.html

A renderer factory to create HTML elements from the Javadoc information returned by the Javadoc tool.

HtmlRendererFactory() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlRendererFactory

Default constructor.

HtmlSeeTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Default implementation that renders the see and link tags as HTML.

HtmlSeeTagRenderer() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlSeeTagRenderer

Default constructor.

HtmlValueTagRenderer - Class in de.smartics.analysis.javadoc.render.html

Default implementation that renders the value tags as HTML.

HtmlValueTagRenderer() - Constructor for class de.smartics.analysis.javadoc.render.html. HtmlValueTagRenderer

I

ImplementsInterfaceFilter - Class in de.smartics.analysis.javadoc.filter

Filters out all classes that do not implement a certain interface.

ImplementsInterfaceFilter(Class<?>) - Constructor for class de.smartics.analysis.javadoc.filter. ImplementsInterfaceFilter

Default constructor.

includes - Variable in class de.smartics.analysis.javadoc.scan. AbstractScannerFactory

The includes for the scanner.

isArchive(String) - Static method in class de.smartics.analysis.javadoc. FileNameUtils

Checks if the given root refers to an archive or not.

isImplementing(ClassDoc, Class<?>) - Static method in class de.smartics.analysis.javadoc.filter. FilterUtils

Checks if the given class is implementing the given interface type.

isInterfaceDeclared(ClassDoc, Class<?>) - Static method in class de.smartics.analysis.javadoc.filter. FilterUtils

Checks if the given class is implementing the given interface type directly.

isRootAccessible(String) - Static method in class de.smartics.analysis.javadoc. FileNameUtils

Checks if root points to a directory of file that is existing and readable.

IssueLocation - Class in de.smartics.analysis.javadoc.log.message

Marks the location of an issue.

IssueLocation(String) - Constructor for class de.smartics.analysis.javadoc.log.message. IssueLocation

Convenience constructor if neither a line or a column number can be given.

IssueLocation(String, int) - Constructor for class de.smartics.analysis.javadoc.log.message. IssueLocation

Convenience constructor if no column number can be given.

IssueLocation(String, int, int) - Constructor for class de.smartics.analysis.javadoc.log.message. IssueLocation

Default constructor.

IssueMessage - Class in de.smartics.analysis.javadoc.log.message

Contains one message reported by the Javadoc tool.

IssueMessage(String) - Constructor for class de.smartics.analysis.javadoc.log.message. IssueMessage

Convenience constructor if no location can be determined.

IssueMessage(IssueLocation, String) - Constructor for class de.smartics.analysis.javadoc.log.message. IssueMessage

Default constructor.

isValidJavaIdentifier(String) - Static method in class de.smartics.analysis.javadoc.filter. FilterUtils

Checks if the given token is a valid Java identifier.

isValidJavaPackageDirPath(String) - Static method in class de.smartics.analysis.javadoc.filter. FilterUtils

Checks that the path is a valid directory path for packages.

J

JavadocArgumentsUtils - Class in de.smartics.analysis.javadoc

Utility class to map information from a project configuration to a map of arguments that can be passed to the Javadoc tool.

JavadocCollector - Interface in de.smartics.analysis.javadoc

Defines the interface to collect specific information from a Java source tree.

JavadocException - Exception in de.smartics.analysis.javadoc

Signals problems reported by the Javadoc tool.

JavadocException(String, Throwable, Console) - Constructor for exception de.smartics.analysis.javadoc. JavadocException

Default constructor.

JavadocException(String, Console) - Constructor for exception de.smartics.analysis.javadoc. JavadocException

Convenience constructor.

JavadocException(Throwable, Console) - Constructor for exception de.smartics.analysis.javadoc. JavadocException

Convenience constructor.

JavadocLoader - Class in de.smartics.analysis.javadoc

Loader for Javadoc information for a class.

JavadocLoader(Collection<String>) - Constructor for class de.smartics.analysis.javadoc. JavadocLoader

Default constructor.

JavadocLoader(String, Collection<String>) - Constructor for class de.smartics.analysis.javadoc. JavadocLoader

Default constructor.

JavadocMessageLogger - Class in de.smartics.analysis.javadoc.log

Helper to collect errors, warnings and notices from the Javadoc tool.

JavadocMessageLogger(PrintWriter, PrintWriter, PrintWriter) - Constructor for class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Constructor to pass pre-configured writers to the instance.

JavadocMessageLogger() - Constructor for class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Default constructor.

JavadocMessageWriter - Class in de.smartics.analysis.javadoc.log

Collects the messages separated by flushes.

JavadocMessageWriter() - Constructor for class de.smartics.analysis.javadoc.log. JavadocMessageWriter

Default constructor.

JavadocProjectConfiguration - Interface in de.smartics.analysis.javadoc.conf

Provides information to be passed to the Javadoc tool.

JavadocRenderer - Class in de.smartics.analysis.javadoc.render

Renderer for Javadoc information.

JavadocRenderer(RendererFactory) - Constructor for class de.smartics.analysis.javadoc.render. JavadocRenderer

Default constructor.

JavadocUtils - Class in de.smartics.analysis.javadoc

Utilities to communicate with the Javadoc tool.

L

languageVersion() - Static method in class de.smartics.analysis.javadoc. CollectorDoclet

Return the version of the Java Programming Language supported by this doclet.

LinkPlainTagRenderer - Interface in de.smartics.analysis.javadoc.render

Renders the linkplain tags.

LiteralTagRenderer - Interface in de.smartics.analysis.javadoc.render

Renders literal tags.

loadClass(ClassLoader, ClassDoc) - Static method in class de.smartics.analysis.javadoc.runtime. RuntimeUtils

Loads the class referenced by the given classDoc.

loadClassFile(String, File) - Method in class de.smartics.analysis.javadoc.runtime. AbstractProjectClassLoader

Loads the class.

loadClassFromLibrary(String, String, File) - Method in class de.smartics.analysis.javadoc.runtime. AbstractProjectClassLoader

Opens a reader to the class file within the archive.

loadEnumInstance(Class<?>, String) - Static method in class de.smartics.analysis.javadoc.runtime. RuntimeUtils

Loads the enumeration element instance with the given identifier from the given class.

loadInstance(ClassLoader, FieldDoc) - Static method in class de.smartics.analysis.javadoc.runtime. RuntimeUtils

Loads the instance referenced by the given fieldDoc.

loadResourceFromLibrary(String, String, File) - Method in class de.smartics.analysis.javadoc.runtime. AbstractProjectClassLoader

Opens a reader to the resource file within the archive.

loadStaticFieldInstance(Class<?>, String) - Static method in class de.smartics.analysis.javadoc.runtime. RuntimeUtils

Loads the static property instance with the given identifier from the given class.

M

MessageParser - Class in de.smartics.analysis.javadoc.log.message

Parses messages issued by the Javadoc tool.

MessageParser() - Constructor for class de.smartics.analysis.javadoc.log.message. MessageParser

Default constructor.

N

normalizePath(String) - Static method in class de.smartics.analysis.javadoc. FileNameUtils

Returns the normalized path where duplicate slashes are removed.

P

PARAM_NAME_PACKAGENAMES - Static variable in class de.smartics.analysis.javadoc. JavadocUtils

The name of the parameter to pass the list of package names as arguments to the Javadoc tool.

PARAM_NAME_SOURCEFILES - Static variable in class de.smartics.analysis.javadoc. JavadocUtils

The name of the parameter to pass the list of source files as arguments to the Javadoc tool.

parseMessage(String) - Method in class de.smartics.analysis.javadoc.log.message. MessageParser

Parses the given message to create an issue message instance.

ProjectClassLoader - Class in de.smartics.analysis.javadoc.runtime

A class loader that serves classes from the given directories.

ProjectClassLoader(List<File>) - Constructor for class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

Convenience constructor using the Thread.currentThread().getContextClassLoader().

ProjectClassLoader(Collection<String>) - Constructor for class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

Convenience constructor to specify the directories as Strings and using the Thread.currentThread().getContextClassLoader().

ProjectClassLoader(ClassLoader, Collection<String>) - Constructor for class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

Convenience constructor to specify the directories as Strings.

ProjectClassLoader(ClassLoader, List<File>) - Constructor for class de.smartics.analysis.javadoc.runtime. ProjectClassLoader

Default constructor.

R

readClassDoc(Class<?>) - Method in class de.smartics.analysis.javadoc. JavadocLoader

render(StringBuilder, Tag) - Method in interface de.smartics.analysis.javadoc.render. CodeTagRenderer

Renders the code tag.

render(StringBuilder, String) - Method in class de.smartics.analysis.javadoc.render. DefaultTextRenderer

Renders the text to the given buffer.

render(StringBuilder, SeeTag) - Method in class de.smartics.analysis.javadoc.render.html. AbstractHtmlSeeTagRenderer

render(StringBuilder, Tag) - Method in class de.smartics.analysis.javadoc.render.html. HtmlCodeTagRenderer

Renders the code tag.

render(StringBuilder, Tag) - Method in class de.smartics.analysis.javadoc.render.html. HtmlLiteralTagRenderer

Renders the literal tag.

render(StringBuilder, Tag) - Method in class de.smartics.analysis.javadoc.render.html. HtmlValueTagRenderer

Renders the value tag.

render(Doc) - Method in class de.smartics.analysis.javadoc.render. JavadocRenderer

Renders the information found in a Javadoc.

render(StringBuilder, SeeTag) - Method in interface de.smartics.analysis.javadoc.render. LinkPlainTagRenderer

Renders the linkplain tag.

render(StringBuilder, Tag) - Method in interface de.smartics.analysis.javadoc.render. LiteralTagRenderer

Renders the literal tag.

render(StringBuilder, SeeTag) - Method in interface de.smartics.analysis.javadoc.render. SeeTagRenderer

Renders the see or link tag.

render(StringBuilder, String) - Method in interface de.smartics.analysis.javadoc.render. TextRenderer

Renders the text to the given buffer.

render(StringBuilder, Tag) - Method in interface de.smartics.analysis.javadoc.render. ValueTagRenderer

Renders the value tag.

RendererFactory - Interface in de.smartics.analysis.javadoc.render

Interface to plugin different renderers into the report generation process.

RuntimeUtils - Class in de.smartics.analysis.javadoc.runtime

Utilities to instantiate classes and access their runtime information.

S

ScannerFactory - Interface in de.smartics.analysis.javadoc.scan

Interface to generate scanners.

SeeTagRenderer - Interface in de.smartics.analysis.javadoc.render

Renders the see and link tags.

setClassRootDirectoryNames(Collection<String>) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the list of class path root elements of this project.

setCollectorContext(CollectorContext) - Static method in class de.smartics.analysis.javadoc. CollectorContextManager

Sets the thread-locally stored collector context.

setExcludes(List<String>) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the excludes for the scanner.

setIncludes(List<String>) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the includes for the scanner.

setResult(List<Doc>) - Method in class de.smartics.analysis.javadoc. CollectorContext

Sets the result of the collection of Javadoc information collected by the doclet.

setReturnCode(int) - Method in class de.smartics.analysis.javadoc. Console

Sets the return code returned by the executed program.

setReturnCode(int) - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Sets the return code reported by the Javadoc tool.

setSourceEncoding(String) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the encoding of the source files in this project.

setSourceRootDirectoryNames(Collection<String>) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the list of source path root elements of this project.

setSourceVersion(String) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the encoding of the source files in this project.

setToolClassPath(List<String>) - Method in class de.smartics.analysis.javadoc.conf. DefaultJavadocProjectConfiguration.Builder

Sets the classpath used by the tool.

split(String) - Static method in class de.smartics.analysis.javadoc.util. StringFunction

Parses the string and returns the comma separated elements as a list of String objects.

split(String, String) - Static method in class de.smartics.analysis.javadoc.util. StringFunction

Parses the string and returns the delimiter separated elements as a list of String objects.

start(RootDoc) - Static method in class de.smartics.analysis.javadoc. CollectorDoclet

Runs the doclets.

StringFunction - Class in de.smartics.analysis.javadoc.util

Provides helper methods for this package.

T

TextRenderer - Interface in de.smartics.analysis.javadoc.render

Interface for renderers to render character streams.

toString() - Method in class de.smartics.analysis.javadoc.log. JavadocMessageLogger

Returns the string representation of the object.

toString() - Method in class de.smartics.analysis.javadoc.log.message. IssueLocation

toString() - Method in class de.smartics.analysis.javadoc.log.message. IssueMessage

V

ValueTagRenderer - Interface in de.smartics.analysis.javadoc.render

Renders value tags.

Z

ZipScannerFactory - Class in de.smartics.analysis.javadoc.scan

Creates directory scanners.

ZipScannerFactory(String[], String[]) - Constructor for class de.smartics.analysis.javadoc.scan. ZipScannerFactory

Constructor.

A B C D E F G H I J L M N P R S T V Z