org.apache.maven.doxia.index
Class IndexEntry

java.lang.Object
  extended by org.apache.maven.doxia.index.IndexEntry
Direct Known Subclasses:
BookIndex

public class IndexEntry
extends java.lang.Object

IndexEntry class.

Version:
$Id: IndexEntry.java 807625 2009-08-25 13:43:52Z vsiveton $
Author:
Trygve Laugstøl

Constructor Summary
IndexEntry(IndexEntry newParent, java.lang.String newId)
          Constructor.
IndexEntry(java.lang.String newId)
          Constructor.
 
Method Summary
 java.util.List getChildEntries()
          Returns an unmodifiableList of the child entries.
 IndexEntry getFirstEntry()
          Returns the first entry.
 java.lang.String getId()
          Returns the id.
 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.
 java.lang.String getTitle()
          Returns the title.
 void setChildEntries(java.util.List entries)
          Sets the child entries or creates a new ArrayList if entries == null.
protected  void setId(java.lang.String id)
          Set the id.
 void setTitle(java.lang.String newTitle)
          Sets the title.
 java.lang.String toString()
           Returns a string representation of the object.
 java.lang.String toString(int depth)
          Returns a string representation of all objects to the given depth.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndexEntry

public IndexEntry(java.lang.String newId)
Constructor.

Parameters:
newId - The id. May be null.

IndexEntry

public IndexEntry(IndexEntry newParent,
                  java.lang.String newId)
Constructor.

Parameters:
newParent - The parent. May be null.
newId - The id. May be null.
Method Detail

getParent

public IndexEntry getParent()
Returns the parent entry.

Returns:
the parent entry.

getId

public java.lang.String getId()
Returns the id.

Returns:
the id.

setId

protected void setId(java.lang.String id)
Set the id.

Since:
1.1.2

getTitle

public java.lang.String getTitle()
Returns the title.

Returns:
the title.

setTitle

public void setTitle(java.lang.String newTitle)
Sets the title.

Parameters:
newTitle - the title.

getChildEntries

public java.util.List getChildEntries()
Returns an unmodifiableList of the child entries.

Returns:
child entries.

setChildEntries

public void setChildEntries(java.util.List entries)
Sets the child entries or creates a new ArrayList if entries == null.

Parameters:
entries - the entries.

getNextEntry

public IndexEntry getNextEntry()
Returns the next entry.

Returns:
the next entry, or null if there is none.

getPrevEntry

public IndexEntry getPrevEntry()
Returns the previous entry.

Returns:
the previous entry, or null if there is none.

getFirstEntry

public IndexEntry getFirstEntry()
Returns the first entry.

Returns:
the first entry, or null if there is none.

getLastEntry

public IndexEntry getLastEntry()
Returns the last entry.

Returns:
the last entry, or null if there is none.

getRootEntry

public IndexEntry getRootEntry()
Returns the root entry.

Returns:
the root entry, or null if there is none.

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(int depth)
Returns a string representation of all objects to the given depth.

Parameters:
depth - The depth to descent to.
Returns:
A string.


Copyright © 2005-2011. All Rights Reserved.