Package com.thoughtworks.qdox.library

Class SourceFolderLibrary

java.lang.Object

com.thoughtworks.qdox.library.AbstractClassLibrary

com.thoughtworks.qdox.library.SourceLibrary

com.thoughtworks.qdox.library.SourceFolderLibrary

All Implemented Interfaces:

ClassLibrary, Serializable

public class SourceFolderLibrary
extends SourceLibrary

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.thoughtworks.qdox.library.AbstractClassLibrary

AbstractClassLibrary.ClassLibraryFilter

Field Summary

Fields

Modifier and Type	Field	Description
private List<File>	sourceFolders

Constructor Summary

Constructors

Constructor	Description
SourceFolderLibrary(AbstractClassLibrary parent)
SourceFolderLibrary(AbstractClassLibrary parent, File sourceFolder)

Method Summary

Modifier and Type	Method	Description
JavaModule	addSourceFolder(File sourceFolder)
protected boolean	containsClassReference(String className)	Loops over the sourceFolder to find a classReference.
Collection<JavaModule>	getJavaModules()
protected JavaClass	resolveJavaClass(String className)	The implementation should check it's sources to see if it can build a JavaClass Model If not, just return null; Once found it will be mapped, so there's no need to keep a reference to this object.
private JavaModule	resolveJavaModule(File sourceFolder)
private Collection<JavaModule>	resolveJavaModules()

Methods inherited from class com.thoughtworks.qdox.library.SourceLibrary

addSource, addSource, addSource, addSource, getEncoding, getErrorHandler, getJavaClasses, getJavaPackages, getJavaSources, isDebugLexer, isDebugParser, parse, parse, registerJavaSource, resolveJavaPackage, setDebugLexer, setDebugParser, setEncoding, setErrorHandler

Methods inherited from class com.thoughtworks.qdox.library.AbstractClassLibrary

getJavaClass, getJavaClass, getJavaClasses, getJavaPackage, getJavaPackages, getJavaSources, getModelBuilder, getModelBuilder, getModelBuilderFactory, getModelWriterFactory, hasClassReference, setModelBuilderFactory, setModelWriterFactory

Methods inherited from class java.lang.Object

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

Field Details

sourceFolders

private List<File> sourceFolders

Constructor Details

SourceFolderLibrary

public SourceFolderLibrary(AbstractClassLibrary parent)

SourceFolderLibrary

public SourceFolderLibrary(AbstractClassLibrary parent,
 File sourceFolder)

Method Details

addSourceFolder

public JavaModule addSourceFolder(File sourceFolder)

getJavaModules

public Collection<JavaModule> getJavaModules()

Specified by:

getJavaModules in interface ClassLibrary

Overrides:

getJavaModules in class AbstractClassLibrary

resolveJavaModules

private Collection<JavaModule> resolveJavaModules()

resolveJavaModule

private JavaModule resolveJavaModule(File sourceFolder)

resolveJavaClass

protected JavaClass resolveJavaClass(String className)

Description copied from class: AbstractClassLibrary

The implementation should check it's sources to see if it can build a JavaClass Model If not, just return null; Once found it will be mapped, so there's no need to keep a reference to this object.

Overrides:

resolveJavaClass in class SourceLibrary

Parameters:

className - the fully qualified name

Returns:

the resolved JavaClass, otherwise null

containsClassReference

protected boolean containsClassReference(String className)

Loops over the sourceFolder to find a classReference. It will try to map the className to a file.

Overrides:

containsClassReference in class SourceLibrary

Parameters:

className - the fully qualified name of the class

Returns:

true if this ClassLibrary has a reference to this class.