- java.lang.Object
-
- com.thoughtworks.qdox.library.JavaClassContext
-
- All Implemented Interfaces:
Serializable
public class JavaClassContext extends Object implements Serializable
JavaClassContext gives you a mechanism to get aJavaClass
. If a class couldn't be found in the cache, the class will be pulled from the classLibrary, the builder will create the corresponding JavaClass and put it in the cache.- Author:
- Robert Scholte
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description JavaClassContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(JavaClass javaClass)
Store thisJavaClass
based on its fully qualified namevoid
add(JavaPackage jPackage)
A null-safe implementation to store aJavaPackage
in this contextvoid
add(JavaSource source)
Store aJavaSource
in this contextJavaClass
getClassByName(String name)
Retrieve theJavaClass
based on thename
.List<JavaClass>
getClasses()
Return all stored JavaClassesJavaPackage
getPackageByName(String name)
Retrieve theJavaPackage
based on thename
.List<JavaPackage>
getPackages()
Return all stored JavaPackagesList<JavaSource>
getSources()
Return all stored JavaSourcesJavaClass
removeClassByName(String name)
Remove and return theJavaClass
based on thename
.JavaPackage
removePackageByName(String name)
Remove and return theJavaPackage
based on thename
.
-
-
-
Method Detail
-
getClassByName
public JavaClass getClassByName(String name)
Retrieve theJavaClass
based on thename
.- Parameters:
name
- the fully qualified name of the class- Returns:
- the stored JavaClass, otherwise
null
-
removeClassByName
public JavaClass removeClassByName(String name)
Remove and return theJavaClass
based on thename
.- Parameters:
name
- the fully qualified name of the class- Returns:
- the removed JavaClass, otherwise
null
-
getClasses
public List<JavaClass> getClasses()
Return all stored JavaClasses- Returns:
- a list of JavaClasses, never
null
-
add
public void add(JavaClass javaClass)
Store thisJavaClass
based on its fully qualified name- Parameters:
javaClass
- the JavaClass to add
-
getPackageByName
public JavaPackage getPackageByName(String name)
Retrieve theJavaPackage
based on thename
.- Parameters:
name
- the fully qualified name of the package- Returns:
- the stored JavaPackage, otherwise
null
-
removePackageByName
public JavaPackage removePackageByName(String name)
Remove and return theJavaPackage
based on thename
.- Parameters:
name
- the fully qualified name of the class- Returns:
- the removed JavaPackage, otherwise
null
-
add
public void add(JavaPackage jPackage)
A null-safe implementation to store aJavaPackage
in this context- Parameters:
jPackage
- the JavaPackage to add
-
getPackages
public List<JavaPackage> getPackages()
Return all stored JavaPackages- Returns:
- a list of JavaPackages, never
null
-
add
public void add(JavaSource source)
Store aJavaSource
in this context- Parameters:
source
- the JavaSource to add
-
getSources
public List<JavaSource> getSources()
Return all stored JavaSources- Returns:
- a list of JavaSources, never
null
-
-