Uses of Class
org.apache.maven.doxia.index.IndexEntry

Packages that use IndexEntry

Package	Description
org.apache.maven.doxia.index
org.apache.maven.doxia.macro.toc
org.apache.maven.doxia.sink.impl

Uses of IndexEntry in org.apache.maven.doxia.index

Fields in org.apache.maven.doxia.index declared as IndexEntry

Modifier and Type	Field	Description
private final IndexEntry	IndexEntry.parent	The parent entry.
private final IndexEntry	IndexingSink.rootEntry

Fields in org.apache.maven.doxia.index with type parameters of type IndexEntry

Modifier and Type	Field	Description
private List<IndexEntry>	IndexEntry.childEntries	The child entries.
private final Stack<IndexEntry>	IndexingSink.stack	The stack.

Methods in org.apache.maven.doxia.index that return IndexEntry

Modifier and Type	Method	Description
IndexEntry	IndexEntry.getFirstEntry()	Returns the first entry.
IndexEntry	IndexEntry.getLastEntry()	Returns the last entry.
IndexEntry	IndexEntry.getNextEntry()	Returns the next entry.
IndexEntry	IndexEntry.getParent()	Returns the parent entry.
IndexEntry	IndexEntry.getPrevEntry()	Returns the previous entry.
IndexEntry	IndexEntry.getRootEntry()	Returns the root entry.
IndexEntry	IndexingSink.getRootEntry()	This should only be called once the sink is closed.
IndexEntry	IndexingSink.peek()	peek.

Methods in org.apache.maven.doxia.index that return types with arguments of type IndexEntry

Modifier and Type	Method	Description
List<IndexEntry>	IndexEntry.getChildEntries()	Returns an unmodifiableList of the child entries.

Methods in org.apache.maven.doxia.index with parameters of type IndexEntry

Modifier and Type	Method	Description
protected 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 IndexEntry

Modifier and Type	Method	Description
void	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 IndexEntry

Modifier	Constructor	Description
	IndexEntry(IndexEntry newParent, String newId)	Constructor.
	IndexEntry(IndexEntry newParent, String newId, IndexEntry.Type type)	Constructor.
	IndexingSink(IndexEntry rootEntry)	Deprecated. legacy constructor, use IndexingSink(Sink) with SinkAdapter as argument and call IndexingSink.getRootEntry() to retrieve the index tree afterwards.
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 IndexEntry

Modifier and Type	Method	Description
(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 IndexEntry

Modifier and Type	Method	Description
protected void	CreateAnchorsForIndexEntries.onIndexEntry(IndexEntry entry)