Package com.thoughtworks.qdox.library
Class AbstractClassLibrary
java.lang.Object
com.thoughtworks.qdox.library.AbstractClassLibrary
- All Implemented Interfaces:
ClassLibrary
,Serializable
- Direct Known Subclasses:
ClassLoaderLibrary
,ClassNameLibrary
,SourceLibrary
A ClassLibrary can be compared with a java classloader.
Its main task is to serve JavaClasses based on the Fully Qualified Name.
AbstractClassLibraries hold a reference a parent library, in which way they can be chained.
Besides that it contains a context only for this library.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static interface
A filter to use when checking all ancestors. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate JavaClassContext
private ModelBuilderFactory
private ModelWriterFactory
private AbstractClassLibrary
-
Constructor Summary
ConstructorsConstructorDescriptionconstructor for root ClassLibraryconstructor for chained ClassLibrary -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract boolean
containsClassReference
(String name) This method is used to detect if there's a match with this classname.private JavaClass
createStub
(String name) final JavaClass
getJavaClass
(String name) First checks if there's a JavaClass available in the private context by this name.final JavaClass
getJavaClass
(String name, boolean createStub) Try to retrieve the JavaClass by the (binary) name.Get all the classes of the currentAbstractClassLibrary
.protected final Collection<JavaClass>
Subclasses can call this method to gather all JavaClass object, including those from the parent.final JavaPackage
getJavaPackage
(String name) Get the JavaPackage or null if it's not possibleGet all packages of the currentAbstractClassLibrary
.protected final Collection<JavaPackage>
Return all JavaSources of the current library.protected final Collection<JavaSource>
protected Builder
If there's a modelBuilderFactory available, ask it for a new instance.protected Builder
getModelBuilder
(URL url) protected final ModelBuilderFactory
protected final ModelWriterFactory
boolean
hasClassReference
(String name) First checks if the context already has a JavaClass with this name.protected abstract JavaClass
resolveJavaClass
(String name) 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.protected abstract JavaPackage
resolveJavaPackage
(String name) final void
Set the ModelBuilderFactory for this classLibrary.final void
setModelWriterFactory
(ModelWriterFactory factory) Set the ModelWriterFactory for this class.
-
Field Details
-
parentClassLibrary
-
modelBuilderFactory
-
modelWriterFactory
-
context
-
-
Constructor Details
-
AbstractClassLibrary
public AbstractClassLibrary()constructor for root ClassLibrary -
AbstractClassLibrary
constructor for chained ClassLibrary- Parameters:
parent
- the parent library
-
-
Method Details
-
getJavaModules
- Specified by:
getJavaModules
in interfaceClassLibrary
-
getJavaClass
First checks if there's a JavaClass available in the private context by this name. Otherwise try to resolve it by the concrete class. If there's still no JavaClass, ask the parent (if available) to resolve it.- Specified by:
getJavaClass
in interfaceClassLibrary
- Parameters:
name
- the binary name of the class- Returns:
- the JavaClass matching the name, otherwise
null
-
getJavaClass
Description copied from interface:ClassLibrary
Try to retrieve the JavaClass by the (binary) name. If the JavaClss doesn't exist and createStub istrue
make a stub, otherwise returnnull
- Specified by:
getJavaClass
in interfaceClassLibrary
- Parameters:
name
- the name of the classcreateStub
- force creation of a stub if the class can't be found- Returns:
- the JavaClass, might be
null
depending on the value of createStub.
-
createStub
-
resolveJavaClass
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.- Parameters:
name
- the fully qualified name- Returns:
- the resolved JavaClass, otherwise
null
-
getJavaSources
Description copied from interface:ClassLibrary
Return all JavaSources of the current library. It's up to the library to decide if also collects JavaSources from it's ancestors- Specified by:
getJavaSources
in interfaceClassLibrary
- Returns:
- all JavaSources as a List, never
null
-
getJavaSources
protected final Collection<JavaSource> getJavaSources(AbstractClassLibrary.ClassLibraryFilter filter) - Parameters:
filter
- the classlibrary filter- Returns:
- JavaSources matching the filter
-
getJavaClasses
Get all the classes of the currentAbstractClassLibrary
. Subclasses can overwrite this method by including the following codepublic List<JavaClass> getClasses() { return getJavaClasses( new ClassLibraryFilter() { public boolean accept( AbstractClassLibrary classLibrary ) { return true; } }); }
This example would return all createdJavaClass
objects, including those from the classloaders.- Specified by:
getJavaClasses
in interfaceClassLibrary
- Returns:
- all JavaClasses of this ClassLibrary
-
getJavaClasses
protected final Collection<JavaClass> getJavaClasses(AbstractClassLibrary.ClassLibraryFilter filter) Subclasses can call this method to gather all JavaClass object, including those from the parent.- Parameters:
filter
- the classlibrary filter- Returns:
- JavaClasses matching the filter
-
getJavaPackages
Get all packages of the currentAbstractClassLibrary
. Subclasses can overwrite this method by including the following codepublic List<JavaPackage> getJavaPackages() { return getJavaPackages( new ClassLibraryFilter() { public boolean accept( AbstractClassLibrary classLibrary ) { return true; } }); }
This example would return all createdJavaPackage
objects, including those from the classloaders.- Specified by:
getJavaPackages
in interfaceClassLibrary
- Returns:
- all JavaPackages of this ClassLibrary
-
getJavaPackage
Description copied from interface:ClassLibrary
Get the JavaPackage or null if it's not possible- Specified by:
getJavaPackage
in interfaceClassLibrary
- Parameters:
name
- the fully qualified name- Returns:
- the JavaPackage matching the name, otherwise
null
-
resolveJavaPackage
-
getJavaPackages
protected final Collection<JavaPackage> getJavaPackages(AbstractClassLibrary.ClassLibraryFilter filter) -
hasClassReference
First checks if the context already has a JavaClass with this name. If not, find out if this classlibrary is able to build a model for this class Otherwise ask the parent if it could build a JavaClass.- Specified by:
hasClassReference
in interfaceClassLibrary
- Parameters:
name
- the fully qualified name- Returns:
true
if there is a reference, otherwisefalse
-
containsClassReference
This method is used to detect if there's a match with this classname. The name could be constructed based on imports and inner class paths.- Parameters:
name
- the fully qualified name of the class- Returns:
- true if this ClassLibrary has a reference to this class.
-
setModelBuilderFactory
Set the ModelBuilderFactory for this classLibrary.- Parameters:
factory
- the model builder factory
-
setModelWriterFactory
Set the ModelWriterFactory for this class.- Parameters:
factory
- the model writer factory
-
getModelWriterFactory
-
getModelBuilderFactory
-
getModelBuilder
If there's a modelBuilderFactory available, ask it for a new instance. Otherwise, return a default ModelBuilder. In both cases, pass this library as argument.- Returns:
- a new instance of a ModelBuilder, never
null
-
getModelBuilder
-