Top Description Inners Fields Constructors Methods

jdk.javadoc.internal.doclets.toolkit.util

public abstract Class SummaryAPIListBuilder

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder

Known Direct Subclasses

jdk.javadoc.internal.doclets.toolkit.util.DeprecatedAPIListBuilder, jdk.javadoc.internal.doclets.toolkit.util.NewAPIBuilder, jdk.javadoc.internal.doclets.toolkit.util.PreviewAPIListBuilder, jdk.javadoc.internal.doclets.toolkit.util.RestrictedAPIListBuilder

Imports

java.util.*, javax.lang.model.element.Element, .ModuleElement, .PackageElement, .RecordComponentElement, .TypeElement, jdk.javadoc.internal.doclets.toolkit.BaseConfiguration

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

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	SummaryAPIListBuilder.SummaryElementKind

Field Summary

Modifier and Type	Field and Description
protected final BaseConfiguration	configuration
private final Map<SummaryAPIListBuilder.SummaryElementKind, SortedSet<Element>>	summaryMap List of summary type Lists.
protected final Utils	utils

Constructor Summary

Access	Constructor and Description
protected	SummaryAPIListBuilder(BaseConfiguration the current configuration of the doclet configuration) Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	Returns: true if the element should be included belongsToSummary(Element an element element) This method decides whether Element `element` should be included in this summary list.
protected void	buildSummaryAPIInfo() Build the sorted list of all the summary APIs in this run.
private void	composeSummaryList(SortedSet<Element> set of summary elements sset, List<? extends Element> members to be added in the list members) Add the members into a single list of summary members.
protected final SortedSet<Element>	Returns: a summary set createSummarySet() Create a summary set of elements.
public SortedSet<Element>	Returns: the set getSet(SummaryAPIListBuilder.SummaryElementKind the SummaryElementKind kind) Return the set of summary elements of a given type.
protected void	handleElement(Element element to process e) Additional extra processing of an included element.
public boolean	hasDocumentation(SummaryAPIListBuilder.SummaryElementKind the type of list being checked. kind) Return true if the list of a given type has size greater than 0.
public boolean	isEmpty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

configuration	back to summary
protected final BaseConfiguration configuration

summaryMap	back to summary
private final Map<SummaryAPIListBuilder.SummaryElementKind, SortedSet<Element>> summaryMap List of summary type Lists.

utils	back to summary
protected final Utils utils

Constructor Detail

SummaryAPIListBuilder	back to summary
protected SummaryAPIListBuilder(BaseConfiguration configuration) Constructor. Parameters configuration:BaseConfiguration the current configuration of the doclet

SummaryAPIListBuilder

back to summary

protected SummaryAPIListBuilder(BaseConfiguration configuration)

Constructor.

Parameters

configuration:BaseConfiguration: the current configuration of the doclet

Method Detail

belongsToSummary back to summary

belongsToSummary	back to summary
protected abstract boolean belongsToSummary(Element element) This method decides whether Element `element` should be included in this summary list. Parameters element:Element an element Returns:boolean true if the element should be included

protected abstract boolean belongsToSummary(Element element)

This method decides whether Element element should be included in this summary list.

Parameters

element:Element: an element

Returns:boolean

true if the element should be included

buildSummaryAPIInfo	back to summary
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.

composeSummaryList	back to summary
private void composeSummaryList(SortedSet<Element> sset, List<? extends Element> members) Add the members into a single list of summary members. Parameters sset:SortedSet<Element> set of summary elements members:List<? extends Element> members to be added in the list

composeSummaryList

back to summary

private void composeSummaryList(SortedSet<Element> sset, List<? extends Element> members)

Add the members into a single list of summary members.

Parameters

sset:SortedSet<Element>: set of summary elements
members:List<? extends Element>: members to be added in the list

createSummarySet	back to summary
protected final SortedSet<Element> createSummarySet() Create a summary set of elements. Returns:SortedSet<Element> a summary set

createSummarySet

back to summary

protected final SortedSet<Element> createSummarySet()

Create a summary set of elements.

Returns:SortedSet<Element>: a summary set

getSet	back to summary
public SortedSet<Element> getSet(SummaryAPIListBuilder.SummaryElementKind kind) Return the set of summary elements of a given type. Parameters kind:SummaryAPIListBuilder.SummaryElementKind the SummaryElementKind Returns:SortedSet<Element> the set

getSet

back to summary

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

Return the set of summary elements of a given type.

Parameters

kind:SummaryAPIListBuilder.SummaryElementKind: the SummaryElementKind

Returns:SortedSet<Element>

the set

handleElement	back to summary
protected void handleElement(Element e) Additional extra processing of an included element. Parameters e:Element element to process

handleElement

back to summary

protected void handleElement(Element e)

Additional extra processing of an included element.

Parameters

e:Element: element to process

hasDocumentation	back to summary
public boolean hasDocumentation(SummaryAPIListBuilder.SummaryElementKind kind) Return true if the list of a given type has size greater than 0. Parameters kind:SummaryAPIListBuilder.SummaryElementKind the type of list being checked.

hasDocumentation

back to summary

public boolean hasDocumentation(SummaryAPIListBuilder.SummaryElementKind kind)

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

Parameters

kind:SummaryAPIListBuilder.SummaryElementKind: the type of list being checked.

isEmpty	back to summary
public boolean isEmpty()

jdk.javadoc.internal.doclets.toolkit.util back to summary

public final Enum SummaryAPIListBuilder.SummaryElementKind

Class Inheritance

extends Enum<SummaryAPIListBuilder.SummaryElementKind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.SummaryElementKind

Field Summary

Modifier and Type	Field and Description
public static final SummaryAPIListBuilder.SummaryElementKind	ANNOTATION_TYPE
public static final SummaryAPIListBuilder.SummaryElementKind	ANNOTATION_TYPE_MEMBER
public static final SummaryAPIListBuilder.SummaryElementKind	CLASS
public static final SummaryAPIListBuilder.SummaryElementKind	CONSTRUCTOR
public static final SummaryAPIListBuilder.SummaryElementKind	ENUM
public static final SummaryAPIListBuilder.SummaryElementKind	ENUM_CONSTANT
public static final SummaryAPIListBuilder.SummaryElementKind	EXCEPTION_CLASS
public static final SummaryAPIListBuilder.SummaryElementKind	FIELD
public static final SummaryAPIListBuilder.SummaryElementKind	INTERFACE
public static final SummaryAPIListBuilder.SummaryElementKind	METHOD
public static final SummaryAPIListBuilder.SummaryElementKind	MODULE
public static final SummaryAPIListBuilder.SummaryElementKind	PACKAGE
public static final SummaryAPIListBuilder.SummaryElementKind	RECORD_CLASS

Constructor Summary

Access	Constructor and Description
private	SummaryElementKind()

Method Summary

Modifier and Type	Method and Description
public static SummaryAPIListBuilder.SummaryElementKind	valueOf(String name)
public static SummaryAPIListBuilder.SummaryElementKind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANNOTATION_TYPE	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind ANNOTATION_TYPE

ANNOTATION_TYPE_MEMBER	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind ANNOTATION_TYPE_MEMBER

CLASS	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind CLASS

CONSTRUCTOR	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind CONSTRUCTOR

ENUM	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind ENUM

ENUM_CONSTANT	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind ENUM_CONSTANT

EXCEPTION_CLASS	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind EXCEPTION_CLASS

FIELD	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind FIELD

INTERFACE	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind INTERFACE

METHOD	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind METHOD

MODULE	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind MODULE

PACKAGE	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind PACKAGE

RECORD_CLASS	back to summary
public static final SummaryAPIListBuilder.SummaryElementKind RECORD_CLASS

Constructor Detail

SummaryElementKind	back to summary
private SummaryElementKind()

Method Detail

valueOf	back to summary
public static SummaryAPIListBuilder.SummaryElementKind valueOf(String name)

values	back to summary
public static SummaryAPIListBuilder.SummaryElementKind[] values()