Package org.apache.maven.doxia.index
Class IndexEntry
java.lang.Object
org.apache.maven.doxia.index.IndexEntry
IndexEntry class.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List<IndexEntry>
The child entries.private static final String
System-dependent EOL.private String
The id of the entry.private final IndexEntry
The parent entry.private String
The entry title. -
Constructor Summary
ConstructorsConstructorDescriptionIndexEntry
(String newId) Constructor.IndexEntry
(IndexEntry newParent, String newId) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturns 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.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. -
title
The entry title. -
childEntries
The child entries. -
EOL
System-dependent EOL.
-
-
Constructor Details
-
IndexEntry
Constructor.- Parameters:
newId
- The id. May be null.
-
IndexEntry
Constructor.- Parameters:
newParent
- The parent. May be null.newId
- The id. May be null.
-
-
Method Details
-
getParent
Returns the parent entry.- Returns:
- the parent entry.
-
getId
Returns the id.- Returns:
- the id.
-
setId
Set the id.- Parameters:
id
- the id- Since:
- 1.1.2
-
getTitle
Returns the title.- Returns:
- the title.
-
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.
-