Constructor Detail

• AbstractClassLibrary

  public AbstractClassLibrary()

  constructor for root ClassLibrary

• AbstractClassLibrary

  public AbstractClassLibrary(AbstractClassLibrary parent)

  constructor for chained ClassLibrary

Method Detail

• getJavaClass

  public final JavaClass getJavaClass(String name)

  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 interface ClassLibrary

  Parameters:

  name -

  Returns:

  the JavaClass matching the name, otherwise null

• getJavaClass

  public final JavaClass getJavaClass(String name,
                       boolean createStub)

  Description copied from interface: ClassLibrary
  Try to retrieve the JavaClass by a fully qualified name. If the JavaClss doesn't exist and createStub is true make a stub, otherwise return null

  Specified by:

  getJavaClass in interface ClassLibrary

  Parameters:

  name - the fully qualified name of the class

  createStub - force creation of a stub if the class can't be found

  Returns:

  the JavaClass, might be null depending on the value of createStub.

• resolveJavaClass

  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.

  Parameters:

  name - the fully qualified name

  Returns:

  the resolved JavaClass, otherwise null

• getJavaSources

  public Collection<JavaSource> 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 interface ClassLibrary

  Returns:

  all JavaSources as a List, never null

• getJavaSources

  protected final Collection<JavaSource> getJavaSources(com.thoughtworks.qdox.library.AbstractClassLibrary.ClassLibraryFilter filter)

  Parameters:

  filter -

  Returns:

  JavaSources matching the filter

• getJavaClasses

  public Collection<JavaClass> getJavaClasses()

  Get all the classes of the current AbstractClassLibrary. Subclasses can overwrite this method by including the following code public List getClasses() { return getJavaClasses( new ClassLibraryFilter() { public boolean accept( AbstractClassLibrary classLibrary ) { return true; } }); } This example would return all created JavaClass objects, including those from the classloaders.

  Specified by:

  getJavaClasses in interface ClassLibrary

  Returns:

  all JavaClasses of this ClassLibrary

• getJavaClasses

  protected final Collection<JavaClass> getJavaClasses(com.thoughtworks.qdox.library.AbstractClassLibrary.ClassLibraryFilter filter)

  Subclasses can call this method to gather all JavaClass object, including those from the parent.

  Parameters:

  filter -

  Returns:

  JavaClasses matching the filter

• getJavaPackages

  public Collection<JavaPackage> getJavaPackages()

  Get all packages of the current AbstractClassLibrary. Subclasses can overwrite this method by including the following code public List getJavaPackages() { return getJavaPackages( new ClassLibraryFilter() { public boolean accept( AbstractClassLibrary classLibrary ) { return true; } }); } This example would return all created JavaPackage objects, including those from the classloaders.

  Specified by:

  getJavaPackages in interface ClassLibrary

  Returns:

  all JavaPackages of this ClassLibrary

• getJavaPackage

  public final JavaPackage getJavaPackage(String name)

  Description copied from interface: ClassLibrary
  Get the JavaPackage or null if it's not possible

  Specified by:

  getJavaPackage in interface ClassLibrary

  Parameters:

  name - the fully qualified name

  Returns:

  the JavaPackage matching the name, otherwise null

• resolveJavaPackage

  protected abstract JavaPackage resolveJavaPackage(String name)

• getJavaPackages

  protected final Collection<JavaPackage> getJavaPackages(com.thoughtworks.qdox.library.AbstractClassLibrary.ClassLibraryFilter filter)

• hasClassReference

  public boolean hasClassReference(String name)

  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 interface ClassLibrary

  Parameters:

  name - the fully qualified name

  Returns:

  true if there is a reference, otherwise false

• containsClassReference

  protected abstract boolean containsClassReference(String name)

  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

  public final void setModelBuilderFactory(ModelBuilderFactory factory)

  Set the ModelBuilderFactory for this classLibrary.

  Parameters:

  factory - the model builder factory

• setModelWriterFactory

  public final void setModelWriterFactory(ModelWriterFactory factory)

  Set the ModelWriterFactory for this class.

  Parameters:

  factory - the model writer factory

• getModelWriterFactory

  protected final ModelWriterFactory getModelWriterFactory()

• getModelBuilderFactory

  protected final ModelBuilderFactory getModelBuilderFactory()

• getModelBuilder

  protected Builder 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

  protected Builder getModelBuilder(URL url)