Package | Description |
---|---|
com.thoughtworks.qdox |
Provides classes to start constructing a java project
|
com.thoughtworks.qdox.builder.impl |
Provides the default implementation of the classes which transform the structs from the JavaParser to the Java model elements
|
com.thoughtworks.qdox.library |
Provides classes to construct a classloader-like structure of libraries
There are two types of ClassLibraryBuilders:
SortedClassLibraryBuilder , which bundles the libraries by type
OrderedClassLibraryBuilder , which respects the order of added libraries
There are four types of ClassLibraries:
ClassLoaderLibrary , which uses the classpath to search for sources or binaries
SourceLibrary , which uses a specific sourcefile
SourceFolderLibrary , which tries to locate sourcefiles by translating the package to folders
ClassNameLibrary , which generates an anonymous class, as if it would exist
|
com.thoughtworks.qdox.model |
Provides classes reflecting the Java model elements.
|
com.thoughtworks.qdox.model.expression |
Provides classes reflecting the Java expressions.
|
com.thoughtworks.qdox.model.impl |
Provides the default implementation of the classes reflecting the Java model elements.
|
com.thoughtworks.qdox.type | |
com.thoughtworks.qdox.writer |
Provides classes to write Java model elements in any style
|
com.thoughtworks.qdox.writer.impl |
Provides the default implementation of classes to write Java model elements in any style.
|
Modifier and Type | Method | Description |
---|---|---|
JavaClass |
JavaProjectBuilder.getClassByName(String name) |
Try to retrieve a
JavaClass by its name. |
Modifier and Type | Method | Description |
---|---|---|
Collection<JavaClass> |
JavaProjectBuilder.getClasses() |
Retrieve all classes which were added by sources
|
Collection<JavaClass> |
JavaProjectBuilder.search(Searcher searcher) |
Modifier and Type | Method | Description |
---|---|---|
boolean |
Searcher.eval(JavaClass cls) |
Evaluate the class
|
Constructor | Description |
---|---|
DefaultJavaAnnotationAssembler(JavaClass declaringClass,
ClassLibrary classLibrary,
TypeResolver typeResolver) |
Modifier and Type | Method | Description |
---|---|---|
JavaClass |
JavaClassContext.getClassByName(String name) |
Retrieve the
JavaClass based on the name . |
JavaClass |
AbstractClassLibrary.getJavaClass(String name) |
First checks if there's a JavaClass available in the private context by this name.
|
JavaClass |
AbstractClassLibrary.getJavaClass(String name,
boolean createStub) |
|
JavaClass |
ClassLibrary.getJavaClass(String name) |
Get the JavaClass or null if it's not possible
|
JavaClass |
ClassLibrary.getJavaClass(String name,
boolean createStub) |
Try to retrieve the JavaClass by the (binary) name.
|
JavaClass |
JavaClassContext.removeClassByName(String name) |
Remove and return the
JavaClass based on the name . |
protected abstract JavaClass |
AbstractClassLibrary.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 JavaClass |
ClassLoaderLibrary.resolveJavaClass(String name) |
|
protected JavaClass |
ClassNameLibrary.resolveJavaClass(String name) |
|
protected JavaClass |
SourceFolderLibrary.resolveJavaClass(String className) |
|
protected JavaClass |
SourceLibrary.resolveJavaClass(String name) |
Modifier and Type | Method | Description |
---|---|---|
List<JavaClass> |
JavaClassContext.getClasses() |
Return all stored JavaClasses
|
Collection<JavaClass> |
AbstractClassLibrary.getJavaClasses() |
Get all the classes of the current
AbstractClassLibrary . |
protected Collection<JavaClass> |
AbstractClassLibrary.getJavaClasses(com.thoughtworks.qdox.library.AbstractClassLibrary.ClassLibraryFilter filter) |
Subclasses can call this method to gather all JavaClass object, including those from the parent.
|
Collection<JavaClass> |
ClassLibrary.getJavaClasses() |
Return all JavaClasses of the current library.
|
Collection<JavaClass> |
SourceLibrary.getJavaClasses() |
Get all classes, including those from parent SourceLibraries
|
Modifier and Type | Method | Description |
---|---|---|
void |
JavaClassContext.add(JavaClass javaClass) |
Store this
JavaClass based on its fully qualified name |
Modifier and Type | Method | Description |
---|---|---|
static JavaClass |
JavaModelUtils.getClassByName(JavaClass cls,
String name) |
Try to resolve the class by the
name , either relative from cls
as the fully qualified name. |
JavaClass |
JavaPackage.getClassByName(String name) |
Try to get any class of this package by name.
|
JavaClass |
JavaSource.getClassByName(String name) |
Try to get any class of this source by name.
|
JavaClass |
JavaClass.getComponentType() |
Equivalent of
Class.getComponentType()
If this type is an array, return its component type |
JavaClass |
JavaClass.getDeclaringClass() |
|
JavaClass |
JavaExecutable.getDeclaringClass() |
|
JavaClass |
JavaMember.getDeclaringClass() |
Equivalent of
Member.getDeclaringClass() |
JavaClass |
JavaParameter.getDeclaringClass() |
The declaring class of the declaring method of this parameter.
|
JavaClass |
JavaField.getEnumConstantClass() |
|
JavaClass |
JavaParameter.getJavaClass() |
|
JavaClass |
JavaClass.getNestedClassByName(String name) |
|
JavaClass |
JavaSource.getNestedClassByName(String name) |
Try to get the JavaClass child based on its name relative to the package.
|
JavaClass |
JavaMethod.getReturns() |
|
JavaClass |
JavaModuleDescriptor.JavaProvides.getService() |
|
JavaClass |
JavaModuleDescriptor.JavaUses.getService() |
|
JavaClass |
JavaClass.getSuperJavaClass() |
Shorthand for getSuperClass().getJavaClass() with null checking.
|
JavaClass |
JavaAnnotation.getType() |
|
JavaClass |
JavaField.getType() |
Equivalent of
Field.getType() |
Modifier and Type | Method | Description |
---|---|---|
Collection<JavaClass> |
JavaPackage.getClasses() |
Returns all the classes found for the package.
|
List<JavaClass> |
JavaSource.getClasses() |
A List with all direct classes of this source, never
null |
List<JavaClass> |
JavaClass.getDerivedClasses() |
Equivalent of
Class.getClasses()
Gets the known derived classes. |
List<JavaClass> |
JavaExecutable.getExceptions() |
Equivalent of
Executable.getExceptionTypes() |
List<JavaClass> |
JavaClass.getInterfaces() |
Equivalent of
Class.getInterfaces()
Determines the interfaces implemented by the class or interface represented by this object. |
List<JavaClass> |
JavaClass.getNestedClasses() |
Equivalent of
Class.getDeclaredClasses() |
Collection<JavaClass> |
JavaModuleDescriptor.JavaProvides.getProviders() |
Modifier and Type | Method | Description |
---|---|---|
static JavaClass |
JavaModelUtils.getClassByName(JavaClass cls,
String name) |
Try to resolve the class by the
name , either relative from cls
as the fully qualified name. |
boolean |
JavaClass.isA(JavaClass javaClass) |
Modifier and Type | Method | Description |
---|---|---|
protected JavaField |
FieldRef.resolveField(JavaClass javaClass,
int start,
int end) |
|
void |
FieldRef.setDeclaringClass(JavaClass declaringClass) |
Modifier and Type | Class | Description |
---|---|---|
class |
DefaultJavaClass |
|
class |
DefaultJavaParameterizedType |
|
class |
DefaultJavaType |
The default implementation for
JavaType |
class |
DefaultJavaTypeVariable<D extends JavaGenericDeclaration> |
Equivalent of
TypeVariable |
class |
DefaultJavaWildcardType |
Equivalent of
WildcardType
This class supports both the 'super' and 'extends' wildcards. |
Modifier and Type | Method | Description |
---|---|---|
JavaClass |
DefaultJavaPackage.getClassByName(String name) |
Try to get any class of this package by name.
|
JavaClass |
DefaultJavaSource.getClassByName(String name) |
Try to get any class of this source by name.
|
JavaClass |
DefaultJavaClass.getComponentType() |
Equivalent of
Class.getComponentType()
If this type is an array, return its component type |
JavaClass |
DefaultJavaType.getComponentType() |
Equivalent of
Class.getComponentType()
If this type is an array, return its component type |
JavaClass |
AbstractBaseJavaEntity.getDeclaringClass() |
Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
|
JavaClass |
AbstractJavaEntity.getDeclaringClass() |
Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
|
JavaClass |
DefaultJavaParameter.getDeclaringClass() |
Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
|
JavaClass |
DefaultJavaType.getDeclaringClass() |
|
JavaClass |
JavaMethodDelegate.getDeclaringClass() |
Equivalent of
Member.getDeclaringClass() |
JavaClass |
DefaultJavaField.getEnumConstantClass() |
|
JavaClass |
DefaultJavaParameter.getJavaClass() |
|
JavaClass |
DefaultJavaClass.getNestedClassByName(String name) |
|
JavaClass |
DefaultJavaSource.getNestedClassByName(String name) |
Try to get the JavaClass child based on its name relative to the package.
|
JavaClass |
DefaultJavaType.getNestedClassByName(String name) |
|
JavaClass |
DefaultJavaMethod.getReturns() |
|
JavaClass |
JavaMethodDelegate.getReturns() |
|
JavaClass |
DefaultJavaModuleDescriptor.DefaultJavaProvides.getService() |
|
JavaClass |
DefaultJavaModuleDescriptor.DefaultJavaUses.getService() |
|
JavaClass |
DefaultJavaClass.getSuperJavaClass() |
Shorthand for getSuperClass().getJavaClass() with null checking.
|
JavaClass |
DefaultJavaType.getSuperJavaClass() |
Shorthand for getSuperClass().getJavaClass() with null checking.
|
JavaClass |
DefaultJavaAnnotation.getType() |
|
JavaClass |
DefaultJavaField.getType() |
Equivalent of
Field.getType() |
Modifier and Type | Method | Description |
---|---|---|
Collection<JavaClass> |
DefaultJavaPackage.getClasses() |
Returns all the classes found for the package.
|
List<JavaClass> |
DefaultJavaSource.getClasses() |
A List with all direct classes of this source, never
null |
List<JavaClass> |
DefaultJavaClass.getDerivedClasses() |
Equivalent of
Class.getClasses()
Gets the known derived classes. |
List<JavaClass> |
DefaultJavaType.getDerivedClasses() |
Equivalent of
Class.getClasses()
Gets the known derived classes. |
List<JavaClass> |
DefaultJavaExecutable.getExceptions() |
Equivalent of
Executable.getExceptionTypes() |
List<JavaClass> |
JavaMethodDelegate.getExceptions() |
Equivalent of
Executable.getExceptionTypes() |
List<JavaClass> |
DefaultJavaClass.getInterfaces() |
Equivalent of
Class.getInterfaces()
Determines the interfaces implemented by the class or interface represented by this object. |
List<JavaClass> |
DefaultJavaType.getInterfaces() |
Equivalent of
Class.getInterfaces()
Determines the interfaces implemented by the class or interface represented by this object. |
List<JavaClass> |
DefaultJavaClass.getNestedClasses() |
Equivalent of
Class.getDeclaredClasses() |
List<JavaClass> |
DefaultJavaType.getNestedClasses() |
Equivalent of
Class.getDeclaredClasses() |
List<JavaClass> |
DefaultJavaModuleDescriptor.DefaultJavaProvides.getProviders() |
|
List<DefaultJavaTypeVariable<JavaClass>> |
DefaultJavaClass.getTypeParameters() |
Equivalent of
GenericDeclaration.getTypeParameters() |
Modifier and Type | Method | Description |
---|---|---|
void |
DefaultJavaClass.addClass(JavaClass cls) |
|
void |
DefaultJavaPackage.addClass(JavaClass clazz) |
|
void |
DefaultJavaSource.addClass(JavaClass cls) |
|
boolean |
DefaultJavaClass.isA(JavaClass javaClass) |
|
boolean |
DefaultJavaType.isA(JavaClass javaClass) |
|
protected static JavaType |
DefaultJavaType.resolve(JavaType base,
JavaClass declaringClass,
JavaClass callingClass) |
Consider the following example
|
void |
AbstractJavaEntity.setDeclaringClass(JavaClass declaringClass) |
|
void |
DefaultJavaField.setEnumConstantClass(JavaClass enumConstantClass) |
|
void |
DefaultJavaMethod.setReturns(JavaClass returns) |
Define the return type of this method
|
void |
DefaultJavaField.setType(JavaClass type) |
Modifier and Type | Method | Description |
---|---|---|
void |
DefaultJavaExecutable.setExceptions(List<JavaClass> exceptions) |
|
void |
DefaultJavaClass.setImplementz(List<JavaClass> implementz) |
|
void |
DefaultJavaClass.setTypeParameters(List<DefaultJavaTypeVariable<JavaClass>> typeParameters) |
Constructor | Description |
---|---|
DefaultJavaAnnotation(JavaClass type) |
|
DefaultJavaAnnotation(JavaClass type,
Map<String,Object> namedParameters) |
|
DefaultJavaField(JavaClass type,
String name) |
|
DefaultJavaMethod(JavaClass returns,
String name) |
Create a new method without parameters
|
DefaultJavaParameter(JavaClass type,
String name) |
|
DefaultJavaParameter(JavaClass type,
String name,
boolean varArgs) |
|
DefaultJavaProvides(JavaClass service,
List<JavaClass> providers) |
|
DefaultJavaUses(JavaClass service) |
|
JavaMethodDelegate(JavaClass callingClass,
JavaMethod originalMethod) |
Constructor | Description |
---|---|
DefaultJavaProvides(JavaClass service,
List<JavaClass> providers) |
Modifier and Type | Method | Description |
---|---|---|
JavaClass |
TypeResolver.getJavaClass(String binaryName) |
|
JavaClass |
TypeResolver.resolveJavaClass(String typeName) |
Modifier and Type | Method | Description |
---|---|---|
ModelWriter |
ModelWriter.writeClass(JavaClass cls) |
Write the java class
A standard class writer should write:
the javadoc
the annotations
the class signature, containing:
the fields
the constructors
the methods
|
Modifier and Type | Method | Description |
---|---|---|
ModelWriter |
DefaultModelWriter.writeClass(JavaClass cls) |
Write the java class
A standard class writer should write:
the javadoc
the annotations
the class signature, containing:
the fields
the constructors
the methods
|
Copyright © 2002–2018. All rights reserved.