Uses of Class
org.apache.maven.doxia.index.IndexEntry
Packages that use IndexEntry
Package
Description
-
Uses of IndexEntry in org.apache.maven.doxia.index
Fields in org.apache.maven.doxia.index declared as IndexEntryModifier and TypeFieldDescriptionprivate final IndexEntry
IndexEntry.parent
The parent entry.private final IndexEntry
IndexingSink.rootEntry
Fields in org.apache.maven.doxia.index with type parameters of type IndexEntryModifier and TypeFieldDescriptionprivate List
<IndexEntry> IndexEntry.childEntries
The child entries.private final Stack
<IndexEntry> IndexingSink.stack
The stack.Methods in org.apache.maven.doxia.index that return IndexEntryModifier and TypeMethodDescriptionIndexEntry.getFirstEntry()
Returns the first entry.IndexEntry.getLastEntry()
Returns the last entry.IndexEntry.getNextEntry()
Returns the next entry.IndexEntry.getParent()
Returns the parent entry.IndexEntry.getPrevEntry()
Returns the previous entry.IndexEntry.getRootEntry()
Returns the root entry.IndexingSink.getRootEntry()
This should only be called once the sink is closed.IndexingSink.peek()
peek.Methods in org.apache.maven.doxia.index that return types with arguments of type IndexEntryModifier and TypeMethodDescriptionIndexEntry.getChildEntries()
Returns an unmodifiableList of the child entries.Methods in org.apache.maven.doxia.index with parameters of type IndexEntryModifier and TypeMethodDescriptionprotected void
IndexingSink.onIndexEntry
(IndexEntry entry) Called at the beginning of each entry (once all metadata about it is collected).void
IndexingSink.push
(IndexEntry entry) Pushes an IndexEntry onto the top of this stack.private void
IndexingSink.setEntryId
(IndexEntry entry, String id) Method parameters in org.apache.maven.doxia.index with type arguments of type IndexEntryModifier and TypeMethodDescriptionvoid
IndexEntry.setChildEntries
(List<IndexEntry> entries) Sets the child entries or creates a new ArrayList if entries == null.Constructors in org.apache.maven.doxia.index with parameters of type IndexEntryModifierConstructorDescriptionIndexEntry
(IndexEntry newParent, String newId) Constructor.IndexEntry
(IndexEntry newParent, String newId, IndexEntry.Type type) Constructor.IndexingSink
(IndexEntry rootEntry) Deprecated.private
IndexingSink
(IndexEntry rootEntry, Sink delegate) Default constructor. -
Uses of IndexEntry in org.apache.maven.doxia.macro.toc
Methods in org.apache.maven.doxia.macro.toc with parameters of type IndexEntryModifier and TypeMethodDescription(package private) static boolean
TocMacro.isRelevantIndexEntry
(IndexEntry indexEntry) private void
TocMacro.writeSubSectionN
(Sink sink, IndexEntry sectionIndex, int n) This recursive method just skips index entries that are not sections (but still evaluates their children).(package private) void
TocMacro.writeTocForIndexEntry
(Sink sink, SinkEventAttributes listAttributes, IndexEntry rootEntry) -
Uses of IndexEntry in org.apache.maven.doxia.sink.impl
Methods in org.apache.maven.doxia.sink.impl with parameters of type IndexEntryModifier and TypeMethodDescriptionprotected void
CreateAnchorsForIndexEntries.onIndexEntry
(IndexEntry entry)
IndexingSink(Sink)
withSinkAdapter
as argument and callIndexingSink.getRootEntry()
to retrieve the index tree afterwards.