de.smartics.analysis.javadoc.conf
Interface JavadocProjectConfiguration

All Known Implementing Classes:

DefaultJavadocProjectConfiguration

public interface JavadocProjectConfiguration

Provides information to be passed to the Javadoc tool.

Author:

Robert Reiner

Method Summary

Collection<String>	getClassRootDirectoryNames() Returns the list of class path root elements of this project.
List<String>	getExcludes() Returns the excludes for the scanner.
List<String>	getIncludes() Returns the includes for the scanner.
ClassLoader	getProjectClassLoader() Returns the class loader to load project classes.
String	getProjectName() Returns the name of the project being processed.
String	getSourceEncoding() Returns the encoding specified for the sources in the project.
Collection<String>	getSourceRootDirectoryNames() Returns the list of source path root elements of this project.
String	getSourceVersion() Returns the Java version specified for the sources in the project.
List<String>	getToolClassPath() Returns the class path elements to use for tools we call.

Method Detail

getProjectName

String getProjectName()

Returns the name of the project being processed.

Returns:

the name of the project being processed.

getToolClassPath

List<String> getToolClassPath()

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

Returns:

the list of class path root elements of this project.

getClassRootDirectoryNames

Collection<String> getClassRootDirectoryNames()

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

Returns:

the list of class path root elements of this project.

getProjectClassLoader

ClassLoader getProjectClassLoader()

Returns the class loader to load project classes.

Returns:

the class loader to load project classes.

getSourceRootDirectoryNames

Collection<String> getSourceRootDirectoryNames()

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

Returns:

the list of source path root elements of this project.

getIncludes

List<String> getIncludes()

Returns the includes for the scanner.

Returns:

the includes for the scanner.

getExcludes

List<String> getExcludes()

Returns the excludes for the scanner.

Returns:

the excludes for the scanner.

getSourceEncoding

String getSourceEncoding()

Returns the encoding specified for the sources in the project.

Returns:

the encoding specified for the sources in the project.

getSourceVersion

String getSourceVersion()

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

Returns:

the Java version specified for the sources in the project.