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

java.lang.Object
  de.smartics.analysis.javadoc.conf.DefaultJavadocProjectConfiguration.Builder

Enclosing class:

DefaultJavadocProjectConfiguration

public static final class DefaultJavadocProjectConfiguration.Builder
     
     

      
      extends 
      
      Object
     
     

The configuration builder.

Constructor Summary

DefaultJavadocProjectConfiguration.Builder(String projectName)
Default constructor.

Method Summary

JavadocProjectConfiguration	build() Creates the project configuration.
void	setClassRootDirectoryNames(Collection<String> classRootDirectoryNames) Sets the list of class path root elements of this project.
void	setExcludes(List<String> excludes) Sets the excludes for the scanner.
void	setIncludes(List<String> includes) Sets the includes for the scanner.
void	setSourceEncoding(String sourceEncoding) Sets the encoding of the source files in this project.
void	setSourceRootDirectoryNames(Collection<String> sourceRootDirectoryNames) Sets the list of source path root elements of this project.
void	setSourceVersion(String sourceVersion) Sets the encoding of the source files in this project.
void	setToolClassPath(List<String> toolClassPath) Sets the classpath used by the tool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJavadocProjectConfiguration.Builder

public DefaultJavadocProjectConfiguration.Builder(String projectName)

Default constructor.

Parameters:

projectName - the name of the project this configuration is for.

Method Detail

setToolClassPath

public void setToolClassPath(List<String> toolClassPath)

Sets the classpath used by the tool.

Parameters:

toolClassPath - the classpath used by the tool.

setClassRootDirectoryNames

public void setClassRootDirectoryNames(Collection<String> classRootDirectoryNames)

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

Parameters:

classRootDirectoryNames - the list of class path root elements of this project.

setSourceRootDirectoryNames

public void setSourceRootDirectoryNames(Collection<String> sourceRootDirectoryNames)

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

Parameters:

sourceRootDirectoryNames - the list of source path root elements of this project.

setIncludes

public void setIncludes(List<String> includes)

Sets the includes for the scanner.

Parameters:

includes - the includes for the scanner.

setExcludes

public void setExcludes(List<String> excludes)

Sets the excludes for the scanner.

Parameters:

excludes - the excludes for the scanner.

setSourceEncoding

public void setSourceEncoding(String sourceEncoding)

Sets the encoding of the source files in this project.

Parameters:

sourceEncoding - the encoding of the source files in this project.

setSourceVersion

public void setSourceVersion(String sourceVersion)

Sets the encoding of the source files in this project. Defaults to 1.5.

Parameters:

sourceVersion - the encoding of the source files in this project.

build

public JavadocProjectConfiguration build()
                                  throws IllegalArgumentException

Creates the project configuration.

Returns:

the project configuration.

Throws:

IllegalArgumentException - if any property is not valid.