OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder

Field Summary

Modifier and Type	Field and Description
protected final BaseConfiguration	configuration
private final Map<IndexItem.Category, SortedSet<IndexItem>>	itemsByCategory Sets of items keyed by the `category` of the items in those sets.
private final Map<Character, SortedSet<IndexItem>>	itemsByFirstChar Sets of items keyed by the first character of the names (labels) of the items in those sets.
private final Comparator<IndexItem>	mainComparator The comparator used for the sets in `itemsByFirstChar`.
private final boolean	noDeprecated Don't generate deprecated information if true.
protected final Utils	utils

Constructor Summary

Access	Constructor and Description
public	IndexBuilder(BaseConfiguration the current configuration of the doclet configuration) Creates a new `IndexBuilder`.

Method Summary

Modifier and Type	Method and Description
public void	add(IndexItem the item to add item) Adds an individual item to the two collections of items.
public void	addElements() Adds all the selected modules, packages, types and their members to the index.
public List<Character>	getFirstCharacters() Returns a sorted list of the first characters of the labels of index items.
private String	getIndexItemKey(IndexItem ii)
public SortedSet<IndexItem>	Returns: list of items keyed by the provided character getItems(Character index key key) Returns a sorted list of items whose names start with the provided character.
public SortedSet<IndexItem>	Returns: list of items keyed by the provided character getItems(IndexItem.Category the category cat) Returns a sorted list of items in a given category.
public SortedSet<IndexItem>	Returns: list of items keyed by the provided character getItems(DocTree.Kind the kind kind) Returns a sorted list of items with a given kind of doc tree.
private void	indexMembers(TypeElement TypeElement whose members are to be indexed te) Indexes all the members (fields, methods, constructors, etc.) of the provided type element.
private void	indexMembers(TypeElement typeElement, Iterable<? extends Element> a collection of elements members) Indexes the provided elements.
private void	indexModules() Indexes all the modules.
private void	indexPackage(PackageElement the package element packageElement) Index the given package element.
private void	indexTypeElements(Iterable<TypeElement> type elements elements) Index the given type elements.
private static Character	keyCharacter(String s)
private Comparator<IndexItem>	Returns: a comparator for index page items makeComparator() Returns a comparator for the `IndexItem`s in the index page.
public Comparator<IndexItem>	Returns: a Comparator makeGenericSearchIndexComparator() Returns a Comparator for IndexItems in the modules, packages, members, and search tags categories of the search index.
public Comparator<IndexItem>	Returns: a Comparator makeTypeSearchIndexComparator() Returns a Comparator for IndexItems in the types category of the search index.
private boolean	shouldIndex(Element element) Should this element be added to the index?

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

itemsByCategory	back to summary
private final Map<IndexItem.Category, SortedSet<IndexItem>> itemsByCategory Sets of items keyed by the `category` of the items in those sets.

itemsByFirstChar	back to summary
private final Map<Character, SortedSet<IndexItem>> itemsByFirstChar Sets of items keyed by the first character of the names (labels) of the items in those sets.

mainComparator	back to summary
private final Comparator<IndexItem> mainComparator The comparator used for the sets in `itemsByFirstChar`.

noDeprecated	back to summary
private final boolean noDeprecated Don't generate deprecated information if true.

utils	back to summary
protected final Utils utils

Constructor Detail

IndexBuilder back to summary

IndexBuilder	back to summary
public IndexBuilder(BaseConfiguration configuration) Creates a new `IndexBuilder`. Parameters configuration:BaseConfiguration the current configuration of the doclet

public IndexBuilder(BaseConfiguration configuration)

Creates a new IndexBuilder.

Parameters

configuration:BaseConfiguration: the current configuration of the doclet

Method Detail

add	back to summary
public void add(IndexItem item) Adds an individual item to the two collections of items. Parameters item:IndexItem the item to add

add

back to summary

public void add(IndexItem item)

Adds an individual item to the two collections of items.

Parameters

item:IndexItem: the item to add

addElements	back to summary
public void addElements() Adds all the selected modules, packages, types and their members to the index.

getFirstCharacters	back to summary
public List<Character> getFirstCharacters() Returns a sorted list of the first characters of the labels of index items.

getIndexItemKey	back to summary
private String getIndexItemKey(IndexItem ii)

getItems	back to summary
public SortedSet<IndexItem> getItems(Character key) Returns a sorted list of items whose names start with the provided character. Parameters key:Character index key Returns:SortedSet<IndexItem> list of items keyed by the provided character

getItems

back to summary

public SortedSet<IndexItem> getItems(Character key)

Returns a sorted list of items whose names start with the provided character.

Parameters

key:Character: index key

Returns:SortedSet<IndexItem>

list of items keyed by the provided character

getItems	back to summary
public SortedSet<IndexItem> getItems(IndexItem.Category cat) Returns a sorted list of items in a given category. Parameters cat:IndexItem.Category the category Returns:SortedSet<IndexItem> list of items keyed by the provided character

getItems

back to summary

public SortedSet<IndexItem> getItems(IndexItem.Category cat)

Returns a sorted list of items in a given category.

Parameters

cat:IndexItem.Category: the category

Returns:SortedSet<IndexItem>

list of items keyed by the provided character

getItems	back to summary
public SortedSet<IndexItem> getItems(DocTree.Kind kind) Returns a sorted list of items with a given kind of doc tree. Parameters kind:DocTree.Kind the kind Returns:SortedSet<IndexItem> list of items keyed by the provided character

getItems

back to summary

public SortedSet<IndexItem> getItems(DocTree.Kind kind)

Returns a sorted list of items with a given kind of doc tree.

Parameters

kind:DocTree.Kind: the kind

Returns:SortedSet<IndexItem>

list of items keyed by the provided character

indexMembers	back to summary
private void indexMembers(TypeElement te) Indexes all the members (fields, methods, constructors, etc.) of the provided type element. Parameters te:TypeElement TypeElement whose members are to be indexed

indexMembers

back to summary

private void indexMembers(TypeElement te)

Indexes all the members (fields, methods, constructors, etc.) of the provided type element.

Parameters

te:TypeElement: TypeElement whose members are to be indexed

indexMembers	back to summary
private void indexMembers(TypeElement typeElement, Iterable<? extends Element> members) Indexes the provided elements. Parameters members:Iterable<? extends Element> a collection of elements

indexMembers

back to summary

private void indexMembers(TypeElement typeElement, Iterable<? extends Element> members)

Indexes the provided elements.

Parameters

members:Iterable<? extends Element>: a collection of elements

indexModules	back to summary
private void indexModules() Indexes all the modules.

indexPackage	back to summary
private void indexPackage(PackageElement packageElement) Index the given package element. Parameters packageElement:PackageElement the package element

indexPackage

back to summary

private void indexPackage(PackageElement packageElement)

Index the given package element.

Parameters

packageElement:PackageElement: the package element

indexTypeElements	back to summary
private void indexTypeElements(Iterable<TypeElement> elements) Index the given type elements. Parameters elements:Iterable<TypeElement> type elements

indexTypeElements

back to summary

private void indexTypeElements(Iterable<TypeElement> elements)

Index the given type elements.

Parameters

elements:Iterable<TypeElement>: type elements

keyCharacter	back to summary
private static Character keyCharacter(String s)

makeComparator back to summary

makeComparator	back to summary
private Comparator<IndexItem> makeComparator() Returns a comparator for the `IndexItem`s in the index page. This is a composite comparator that must be able to compare all kinds of items: for element items, tag items, and others. Returns:Comparator<IndexItem> a comparator for index page items

private Comparator<IndexItem> makeComparator()

Returns a comparator for the IndexItems in the index page. This is a composite comparator that must be able to compare all kinds of items: for element items, tag items, and others.

Returns:Comparator<IndexItem>: a comparator for index page items

makeGenericSearchIndexComparator	back to summary
public Comparator<IndexItem> makeGenericSearchIndexComparator() Returns a Comparator for IndexItems in the modules, packages, members, and search tags categories of the search index. Items are compared by label, falling back to the main comparator if names are equal. Returns:Comparator<IndexItem> a Comparator

makeGenericSearchIndexComparator

back to summary

public Comparator<IndexItem> makeGenericSearchIndexComparator()

Returns a Comparator for IndexItems in the modules, packages, members, and search tags categories of the search index. Items are compared by label, falling back to the main comparator if names are equal.

Returns:Comparator<IndexItem>: a Comparator

makeTypeSearchIndexComparator	back to summary
public Comparator<IndexItem> makeTypeSearchIndexComparator() Returns a Comparator for IndexItems in the types category of the search index. Items are compared by short name, falling back to the main comparator if names are equal. Returns:Comparator<IndexItem> a Comparator

makeTypeSearchIndexComparator

back to summary

public Comparator<IndexItem> makeTypeSearchIndexComparator()

Returns a Comparator for IndexItems in the types category of the search index. Items are compared by short name, falling back to the main comparator if names are equal.

Returns:Comparator<IndexItem>: a Comparator

shouldIndex	back to summary
private boolean shouldIndex(Element element) Should this element be added to the index?

public abstract Class IndexBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail