Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse TypeElementCatalog

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.util.TypeElementCatalog

public class TypeElementCatalog
extends Object

This class acts as an artificial container for classes specified on the command line when running Javadoc.

For example, if you specify several classes from package java.lang, this class will catalog those classes so that we can retrieve all of the classes from a particular package later.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TypeElementCatalog(Iterable<TypeElement> typeElements, BaseConfiguration config)	Construct a new TypeElementCatalog.
TypeElementCatalog(BaseConfiguration config)	Construct a new TypeElementCatalog.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
final void	addTypeElement(TypeElement typeElement)	Add the given class to the catalog.
SortedSet<TypeElement>	allClasses(PackageElement packageElement)	Return all of the classes specified on the command-line that belong to the given package.
SortedSet<TypeElement>	allUnnamedClasses()	Return all of the classes specified on the command-line that belong to the unnamed package.
SortedSet<PackageElement>	packages()	Return a SortedSet of packages that this catalog stores.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

TypeElementCatalog

public TypeElementCatalog(Iterable<TypeElement> typeElements,
 BaseConfiguration config)

Construct a new TypeElementCatalog.

Parameter:

typeElements - the array of TypeElements to catalog

TypeElementCatalog

public TypeElementCatalog(BaseConfiguration config)

Construct a new TypeElementCatalog.

Methodendetails

addTypeElement

public final void addTypeElement(TypeElement typeElement)

Add the given class to the catalog.

Parameter:

typeElement - the TypeElement to add to the catalog.

allClasses

public SortedSet<TypeElement> allClasses(PackageElement packageElement)

Return all of the classes specified on the command-line that belong to the given package.

Parameter:

packageElement - the package to return the classes for.

allUnnamedClasses

public SortedSet<TypeElement> allUnnamedClasses()

Return all of the classes specified on the command-line that belong to the unnamed package.

packages

public SortedSet<PackageElement> packages()

Return a SortedSet of packages that this catalog stores.