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

Klasse SummaryAPIListBuilder

java.lang.Object

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

Bekannte direkte Unterklassen:

DeprecatedAPIListBuilder, NewAPIBuilder, PreviewAPIListBuilder

public class SummaryAPIListBuilder
extends Object

Build list of all the summary packages, classes, constructors, fields and methods.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	SummaryAPIListBuilder.SummaryElementKind

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final BaseConfiguration	configuration
protected final Utils	utils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SummaryAPIListBuilder(BaseConfiguration configuration, Predicate<Element> belongsToSummary)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	buildSummaryAPIInfo()	Build the sorted list of all the summary APIs in this run.
protected final SortedSet<Element>	createSummarySet()	Create a summary set of elements.
SortedSet<Element>	getSet(SummaryAPIListBuilder.SummaryElementKind kind)	Return the list of summary elements of a given type.
protected void	handleElement(Element e)	Additional extra processing of an included element.
boolean	hasDocumentation(SummaryAPIListBuilder.SummaryElementKind kind)	Return true if the list of a given type has size greater than 0.
boolean	isEmpty()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

configuration

protected final BaseConfiguration configuration

utils

protected final Utils utils

Konstruktordetails

SummaryAPIListBuilder

public SummaryAPIListBuilder(BaseConfiguration configuration,
 Predicate<Element> belongsToSummary)

Constructor.

Parameter:

configuration - the current configuration of the doclet

Methodendetails

isEmpty

public boolean isEmpty()

buildSummaryAPIInfo

protected void buildSummaryAPIInfo()

Build the sorted list of all the summary APIs in this run.

Build separate lists for summary modules, packages, classes, constructors, methods and fields.

getSet

public SortedSet<Element> getSet(SummaryAPIListBuilder.SummaryElementKind kind)

Return the list of summary elements of a given type.

Parameter:

kind - the SummaryElementKind

Gibt zurück:

hasDocumentation

public boolean hasDocumentation(SummaryAPIListBuilder.SummaryElementKind kind)

Return true if the list of a given type has size greater than 0.

Parameter:

kind - the type of list being checked.

handleElement

protected void handleElement(Element e)

Additional extra processing of an included element.

Parameter:

e - element to process

createSummarySet

protected final SortedSet<Element> createSummarySet()

Create a summary set of elements.

Gibt zurück:

a summary set