Package org.apache.maven.doxia.index
Class IndexEntry
java.lang.Object
org.apache.maven.doxia.index.IndexEntry
Representing the index tree within a document with the most important metadata per entry.
Currently this only contains entries for sections, but in the future may be extended, therefore it
is recommended to use
getType()
to filter out irrelevant entries.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
<IndexEntry> The child entries.private boolean
true if there is already an anchor for thisprivate String
The id of the entry.private final IndexEntry
The parent entry.private String
The entry title.private final IndexEntry.Type
The type of the entry, one of the types defined byIndexingSink
-
Constructor Summary
ConstructorsConstructorDescriptionIndexEntry
(String newId) Constructor for root entry.IndexEntry
(IndexEntry newParent, String newId) Constructor.IndexEntry
(IndexEntry newParent, String newId, IndexEntry.Type type) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns an unmodifiableList of the child entries.Returns the first entry.getId()
Returns the id.Returns the last entry.Returns the next entry.Returns the parent entry.Returns the previous entry.Returns the root entry.getTitle()
Returns the title.getType()
Returns the type of this entry.boolean
Returns if the entry's id already has an anchor in the underlying document.int
hashCode()
boolean
hasId()
Returns if the entry has an id.void
setAnchor
(boolean hasAnchor) Set if the entry's id already has an anchor in the underlying document.void
setChildEntries
(List<IndexEntry> entries) Sets the child entries or creates a new ArrayList if entries == null.protected void
Set the id.void
Sets the title.toString()
Returns a string representation of the object.toString
(int depth) Returns a string representation of all objects to the given depth.
-
Field Details
-
parent
The parent entry. -
id
The id of the entry. -
hasAnchor
private boolean hasAnchortrue if there is already an anchor for this -
title
The entry title. -
childEntries
The child entries. -
type
The type of the entry, one of the types defined byIndexingSink
-
-
Constructor Details
-
IndexEntry
Constructor for root entry.- Parameters:
newId
- The id. May be null.
-
IndexEntry
Constructor.- Parameters:
newParent
- The parent. May be null.newId
- The id. May be null.
-
IndexEntry
Constructor.- Parameters:
newParent
- The parent. May be null.newId
- The id. May be null.type
- The type. Cannot be null.
-
-
Method Details
-
getParent
Returns the parent entry.- Returns:
- the parent entry.
-
getId
Returns the id.- Returns:
- the id.
-
hasId
public boolean hasId()Returns if the entry has an id.- Returns:
true
if the entry has a valid id, otherwise it can be considered invalid/empty.
-
setId
Set the id.- Parameters:
id
- the id- Since:
- 1.1.2
-
getType
Returns the type of this entry. Is one of the types defined byIndexingSink
.- Returns:
- the type of this entry
- Since:
- 2.0.0
-
setAnchor
public void setAnchor(boolean hasAnchor) Set if the entry's id already has an anchor in the underlying document.- Parameters:
hasAnchor
-true
if the id already has an anchor.- Since:
- 2.0.0
-
hasAnchor
public boolean hasAnchor()Returns if the entry's id already has an anchor in the underlying document.- Returns:
true
if the id already has an anchor otherwisefalse
.- Since:
- 2.0.0
-
getTitle
Returns the title.- Returns:
- the title (may be
null
).
-
setTitle
Sets the title.- Parameters:
newTitle
- the title.
-
getChildEntries
Returns an unmodifiableList of the child entries.- Returns:
- child entries.
-
setChildEntries
Sets the child entries or creates a new ArrayList if entries == null.- Parameters:
entries
- the entries.
-
getNextEntry
Returns the next entry.- Returns:
- the next entry, or null if there is none.
-
getPrevEntry
Returns the previous entry.- Returns:
- the previous entry, or null if there is none.
-
getFirstEntry
Returns the first entry.- Returns:
- the first entry, or null if there is none.
-
getLastEntry
Returns the last entry.- Returns:
- the last entry, or null if there is none.
-
getRootEntry
Returns the root entry.- Returns:
- the root entry, or null if there is none.
-
toString
Returns a string representation of the object. -
toString
Returns a string representation of all objects to the given depth.- Parameters:
depth
- The depth to descent to.- Returns:
- A string.
-
hashCode
public int hashCode() -
equals
-