de.smartics.testdoc.collect.generator
Class TestDocGenerator.Config.Builder

java.lang.Object
  de.smartics.testdoc.collect.generator.TestDocGenerator.Config.Builder

Enclosing class:

TestDocGenerator.Config

public static final class TestDocGenerator.Config.Builder
     
     

      
      extends 
      
      Object
     
     

The builder to collect information and construct the config instance.

Author:

Robert Reiner

Constructor Summary

TestDocGenerator.Config.Builder()

Method Summary

void	setCharset(Charset charset) Sets the charset to read the source files.
void	setCharsetByEncoding(String encoding) Sets the charset to read the source files by the name of the character encoding.
void	setClassPathElements(List<String> classPathElements)
void	setExportAdapterName(Class<? extends ExportAdapter> exportAdapterType) Sets the name of the export adapter to use.
void	setExportAdapterName(String exportAdapterName) Sets the name of the export adapter to use.
void	setLocale(Locale locale) Sets the locale to read the source files.
void	setRootDirs(Collection<File> rootDirs) Sets the root directories that contain the source files to process.
void	setRootDirsAsString(Collection<String> rootDirs) Sets the root directories that contain the source files to process.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDocGenerator.Config.Builder

public TestDocGenerator.Config.Builder()

Method Detail

setCharsetByEncoding

public void setCharsetByEncoding(String encoding)
                          throws IllegalCharsetNameException,
                                 IllegalArgumentException,
                                 UnsupportedCharsetException

Sets the charset to read the source files by the name of the character encoding.

Parameters:

encoding - the name of the character encoding to read the source files.

Throws:

IllegalCharsetNameException - if the charset name referenced by the encoding is illegal.

IllegalArgumentException - if the given encoding is null.

UnsupportedCharsetException - if no support for the encoding is available in this instance of the Java virtual machine.

setCharset

public void setCharset(Charset charset)

Sets the charset to read the source files.

Parameters:

charset - the charset to read the source files.

setLocale

public void setLocale(Locale locale)

Sets the locale to read the source files.

Parameters:

locale - the locale to read the source files.

setRootDirsAsString

public void setRootDirsAsString(Collection<String> rootDirs)

Sets the root directories that contain the source files to process.

Parameters:

rootDirs - the root directories that contain the source files to process.

setRootDirs

public void setRootDirs(Collection<File> rootDirs)

Sets the root directories that contain the source files to process.

Parameters:

rootDirs - the root directories that contain the source files to process.

setExportAdapterName

public void setExportAdapterName(String exportAdapterName)
                          throws InstantiationException,
                                 IllegalAccessException,
                                 ExceptionInInitializerError,
                                 ClassNotFoundException

Sets the name of the export adapter to use.

Parameters:

exportAdapterName - the name of the export adapter to use. * @throws LinkageError if the linkage fails

Throws:

ExceptionInInitializerError - if the initialization provoked by this method fails

ClassNotFoundException - if the class cannot be located

IllegalAccessException - if the class or its nullary constructor is not accessible.

InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

ExceptionInInitializerError - if the initialization provoked by this method fails.

SecurityException - If a security manager, s, is present and any of the following conditions is met:

• invocation of s.checkMemberAccess(this, Member.PUBLIC) denies creation of new instances of this class
• the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class

setExportAdapterName

public void setExportAdapterName(Class<? extends ExportAdapter> exportAdapterType)
                          throws InstantiationException,
                                 IllegalAccessException,
                                 ExceptionInInitializerError,
                                 SecurityException

Sets the name of the export adapter to use. Default to SingletonInMemoryExportAdapter.

Parameters:

exportAdapterType - the type of the export adapter to use.

Throws:

IllegalAccessException - if the class or its nullary constructor is not accessible.

InstantiationException - if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.

ExceptionInInitializerError - if the initialization provoked by this method fails.

SecurityException - If a security manager, s, is present and any of the following conditions is met:

• invocation of s.checkMemberAccess(this, Member.PUBLIC) denies creation of new instances of this class
• the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of s.checkPackageAccess() denies access to the package of this class

setClassPathElements

public void setClassPathElements(List<String> classPathElements)