com.thoughtworks.qdox.library

Class JavaClassContext

java.lang.Object

com.thoughtworks.qdox.library.JavaClassContext

All Implemented Interfaces:

java.io.Serializable

public class JavaClassContext
extends java.lang.Object
implements java.io.Serializable

JavaClassContext gives you a mechanism to get a JavaClass. 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 and Description
JavaClassContext()

Method Summary

Modifier and Type	Method and Description
void	add(JavaClass javaClass) Store this JavaClass based on its fully qualified name
void	add(JavaPackage jPackage) A null-safe implementation to store a JavaPackage in this context
void	add(JavaSource source) Store a JavaSource in this context
JavaClass	getClassByName(java.lang.String name) Retrieve the JavaClass based on the name.
java.util.List<JavaClass>	getClasses() Return all stored JavaClasses
JavaPackage	getPackageByName(java.lang.String name) Retrieve the JavaPackage based on the name.
java.util.List<JavaPackage>	getPackages() Return all stored JavaPackages
java.util.List<JavaSource>	getSources() Return all stored JavaSources
JavaClass	removeClassByName(java.lang.String name) Remove and return the JavaClass based on the name.
JavaPackage	removePackageByName(java.lang.String name) Remove and return the JavaPackage based on the name.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaClassContext

public JavaClassContext()

Method Detail

getClassByName

public JavaClass getClassByName(java.lang.String name)

Retrieve the JavaClass based on the name.

Parameters:

name - the fully qualified name of the class

Returns:

the stored JavaClass, otherwise null

removeClassByName

public JavaClass removeClassByName(java.lang.String name)

Remove and return the JavaClass based on the name.

Parameters:

name - the fully qualified name of the class

Returns:

the removed JavaClass, otherwise null

getClasses

public java.util.List<JavaClass> getClasses()

Return all stored JavaClasses

Returns:

a list of JavaClasses, never null

add

public void add(JavaClass javaClass)

Store this JavaClass based on its fully qualified name

Parameters:

javaClass - the JavaClass to add

getPackageByName

public JavaPackage getPackageByName(java.lang.String name)

Retrieve the JavaPackage based on the name.

Parameters:

name - the fully qualified name of the package

Returns:

the stored JavaPackage, otherwise null

removePackageByName

public JavaPackage removePackageByName(java.lang.String name)

Remove and return the JavaPackage based on the name.

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 a JavaPackage in this context

Parameters:

jPackage - the JavaPackage to add

getPackages

public java.util.List<JavaPackage> getPackages()

Return all stored JavaPackages

Returns:

a list of JavaPackages, never null

add

public void add(JavaSource source)

Store a JavaSource in this context

Parameters:

source - the JavaSource to add

getSources

public java.util.List<JavaSource> getSources()

Return all stored JavaSources

Returns:

a list of JavaSources, never null