Package com.thoughtworks.qdox.library

Class OrderedClassLibraryBuilder

java.lang.Object

com.thoughtworks.qdox.library.OrderedClassLibraryBuilder

All Implemented Interfaces:

ClassLibraryBuilder, Serializable

public class OrderedClassLibraryBuilder
extends Object
implements ClassLibraryBuilder

This library resolves JavaClasses in the order in which class sources are added.

Since:

2.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractClassLibrary	classLibrary
private boolean	debugLexer
private boolean	debugParser
private String	encoding
private ErrorHandler	errorHandler
private ModelBuilderFactory	modelBuilderFactory
private ModelWriterFactory	modelWriterFactory

Constructor Summary

Constructors

Constructor	Description
OrderedClassLibraryBuilder()	Default constructor which sets the root classLibrary to ClassNameLibrary.
OrderedClassLibraryBuilder(AbstractClassLibrary rootClassLibrary)	Constructor for which you can set the root ClassLibrary If you set this to null, all classes should be available on the classpath.

Method Summary

Modifier and Type	Method	Description
JavaSource	addSource(File file)
JavaSource	addSource(InputStream stream)
JavaSource	addSource(Reader reader)	Add the source content of the reader to the ClassLibrary and return the generated JavaSource
JavaSource	addSource(URL url)
JavaModule	addSourceFolder(File sourceFolder)
ClassLibraryBuilder	appendClassLoader(ClassLoader classLoader)	Append a classloader and return itself
ClassLibraryBuilder	appendDefaultClassLoaders()	Add the defaultClassLoaders and return itse
ClassLibraryBuilder	appendSource(File file)
ClassLibraryBuilder	appendSource(InputStream stream)
ClassLibraryBuilder	appendSource(Reader reader)
ClassLibraryBuilder	appendSource(URL url)
ClassLibraryBuilder	appendSourceFolder(File sourceFolder)
ClassLibrary	getClassLibrary()	Get the library based on the strategy of the implementation
private SourceFolderLibrary	getSourceFolderLibrary()
protected final SourceLibrary	getSourceLibrary()
protected ClassLoaderLibrary	newClassLoaderLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of ClassLoaderLibrary
protected SourceFolderLibrary	newSourceFolderLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of SourceFolderLibrary
protected SourceLibrary	newSourceLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of SourceLibrary
private void	prepareSourceLibrary(SourceLibrary sourceLibrary)
ClassLibraryBuilder	setDebugLexer(boolean debugLexer)	Set to true to enable debug logging for the lexer
ClassLibraryBuilder	setDebugParser(boolean debugParser)	Set to true to enable debug logging for the parser
ClassLibraryBuilder	setEncoding(String encoding)
ClassLibraryBuilder	setErrorHander(ErrorHandler errorHandler)	Can handle ParseExceptions instead of crashing.
ClassLibraryBuilder	setModelBuilderFactory(ModelBuilderFactory modelBuilderFactory)	Define the ModelBuilderFactory which the parsers should use to construct the JavaModel Objects
ClassLibraryBuilder	setModelWriterFactory(ModelWriterFactory modelWriterFactory)	Define the ModelWriterFactory which is used by the classes when calling for the codeBlock.

Methods inherited from class java.lang.Object

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

Field Details

classLibrary

private AbstractClassLibrary classLibrary

debugLexer

private boolean debugLexer

debugParser

private boolean debugParser

encoding

private String encoding

errorHandler

private ErrorHandler errorHandler

modelBuilderFactory

private ModelBuilderFactory modelBuilderFactory

modelWriterFactory

private ModelWriterFactory modelWriterFactory

Constructor Details

OrderedClassLibraryBuilder

public OrderedClassLibraryBuilder()

Default constructor which sets the root classLibrary to ClassNameLibrary. This way every class will be resolved, even if it's not on the classpath.

OrderedClassLibraryBuilder

public OrderedClassLibraryBuilder(AbstractClassLibrary rootClassLibrary)

Constructor for which you can set the root ClassLibrary If you set this to null, all classes should be available on the classpath.

Parameters:

rootClassLibrary - the parent Classlibrary

Method Details

appendClassLoader

public ClassLibraryBuilder appendClassLoader(ClassLoader classLoader)

Description copied from interface: ClassLibraryBuilder

Append a classloader and return itself

Specified by:

appendClassLoader in interface ClassLibraryBuilder

Parameters:

classLoader - the classloader to add

Returns:

this ClassLibraryBuilder instance

appendDefaultClassLoaders

public ClassLibraryBuilder appendDefaultClassLoaders()

Description copied from interface: ClassLibraryBuilder

Add the defaultClassLoaders and return itse

Specified by:

appendDefaultClassLoaders in interface ClassLibraryBuilder

Returns:

this ClassLibraryBuilder instance

appendSourceFolder

public ClassLibraryBuilder appendSourceFolder(File sourceFolder)

Specified by:

appendSourceFolder in interface ClassLibraryBuilder

Parameters:

sourceFolder - the source folder

Returns:

this ClassLibraryBuilder instance

appendSource

public ClassLibraryBuilder appendSource(InputStream stream)
                                 throws IOException

Specified by:

appendSource in interface ClassLibraryBuilder

Parameters:

stream - the Java source as stream

Returns:

this ClassLibraryBuilder instance

Throws:

IOException - if an IOException is thrown, e.g. unsupported encoding

appendSource

public ClassLibraryBuilder appendSource(Reader reader)

Specified by:

appendSource in interface ClassLibraryBuilder

Parameters:

reader - the Java source as reader

Returns:

this ClassLibraryBuilder instance

setDebugLexer

public ClassLibraryBuilder setDebugLexer(boolean debugLexer)

Description copied from interface: ClassLibraryBuilder

Set to true to enable debug logging for the lexer

Specified by:

setDebugLexer in interface ClassLibraryBuilder

Parameters:

debugLexer - the debug logging flag

Returns:

this ClassLibraryBuilder instance

setDebugParser

public ClassLibraryBuilder setDebugParser(boolean debugParser)

Description copied from interface: ClassLibraryBuilder

Set to true to enable debug logging for the parser

Specified by:

setDebugParser in interface ClassLibraryBuilder

Parameters:

debugParser - the debug logging flag

Returns:

this ClassLibraryBuilder instance

setEncoding

public ClassLibraryBuilder setEncoding(String encoding)

Specified by:

setEncoding in interface ClassLibraryBuilder

Parameters:

encoding - set the encoding

Returns:

this ClassLibraryBuilder instance

setErrorHander

public ClassLibraryBuilder setErrorHander(ErrorHandler errorHandler)

Description copied from interface: ClassLibraryBuilder

Can handle ParseExceptions instead of crashing. Has only effect on the appendSource() methods

Specified by:

setErrorHander in interface ClassLibraryBuilder

Parameters:

errorHandler - the errorHandler

Returns:

this ClassLibraryBuilder instance

setModelBuilderFactory

public ClassLibraryBuilder setModelBuilderFactory(ModelBuilderFactory modelBuilderFactory)

Description copied from interface: ClassLibraryBuilder

Define the ModelBuilderFactory which the parsers should use to construct the JavaModel Objects

Specified by:

setModelBuilderFactory in interface ClassLibraryBuilder

Parameters:

modelBuilderFactory - the modelBuilderFactory

Returns:

this ClassLibraryBuilder instance

setModelWriterFactory

public ClassLibraryBuilder setModelWriterFactory(ModelWriterFactory modelWriterFactory)

Description copied from interface: ClassLibraryBuilder

Define the ModelWriterFactory which is used by the classes when calling for the codeBlock.

Specified by:

setModelWriterFactory in interface ClassLibraryBuilder

Parameters:

modelWriterFactory - the modelWriterFactory

Returns:

this ClassLibraryBuilder instance

getClassLibrary

public ClassLibrary getClassLibrary()

Description copied from interface: ClassLibraryBuilder

Get the library based on the strategy of the implementation

Specified by:

getClassLibrary in interface ClassLibraryBuilder

Returns:

the constructed ClassLibrary

appendSource

public ClassLibraryBuilder appendSource(URL url)
                                 throws IOException

Specified by:

appendSource in interface ClassLibraryBuilder

Parameters:

url - the Java source as URL

Returns:

this ClassLibraryBuilder instance

Throws:

IOException - if an IOException occurs

appendSource

public ClassLibraryBuilder appendSource(File file)
                                 throws IOException

Specified by:

appendSource in interface ClassLibraryBuilder

Parameters:

file - the Java source as file

Returns:

this ClassLibraryBuilder instance

Throws:

IOException - if an IOException occurs

addSource

public JavaSource addSource(InputStream stream)
                     throws IOException

Specified by:

addSource in interface ClassLibraryBuilder

Parameters:

stream - the Java source as stream

Returns:

the created JavaSource

Throws:

IOException - if an IOException is thrown, e.g. unsupported encoding

addSource

public JavaSource addSource(Reader reader)

Description copied from interface: ClassLibraryBuilder

Add the source content of the reader to the ClassLibrary and return the generated JavaSource

Specified by:

addSource in interface ClassLibraryBuilder

Parameters:

reader - the Java source as reader

Returns:

the created JavaSource

addSource

public JavaSource addSource(URL url)
                     throws IOException

Specified by:

addSource in interface ClassLibraryBuilder

Parameters:

url - the Java source as URL

Returns:

the created JavaSource

Throws:

IOException - if an IOException occurs

addSource

public JavaSource addSource(File file)
                     throws IOException

Specified by:

addSource in interface ClassLibraryBuilder

Parameters:

file - the Java source as file

Returns:

the created JavaSource

Throws:

IOException - if an IOException occurs

addSourceFolder

public JavaModule addSourceFolder(File sourceFolder)

Specified by:

addSourceFolder in interface ClassLibraryBuilder

Parameters:

sourceFolder - the sourcefolder

Returns:

the module info if the sourcefolder has a module-info.java, otherwise null

prepareSourceLibrary

private void prepareSourceLibrary(SourceLibrary sourceLibrary)

getSourceLibrary

protected final SourceLibrary getSourceLibrary()

getSourceFolderLibrary

private SourceFolderLibrary getSourceFolderLibrary()

newClassLoaderLibrary

protected ClassLoaderLibrary newClassLoaderLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of ClassLoaderLibrary

Parameters:

parentLibrary - the parent library

Returns:

a new ClassLoaderLibrary instance

Since:

2.0

newSourceLibrary

protected SourceLibrary newSourceLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of SourceLibrary

Parameters:

parentLibrary - the parent library

Returns:

a new SourceLibrary instance

Since:

2.0

newSourceFolderLibrary

protected SourceFolderLibrary newSourceFolderLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of SourceFolderLibrary

Parameters:

parentLibrary - the parent library

Returns:

a new SourceFolderLibrary instance

Since:

2.0