org.apache.maven.doxia.index

Class IndexEntry

public class IndexEntry extends Object

Version: $Id: IndexEntry.java 559578 2007-07-25 20:12:56Z ltheussl $

Author: Trygve Laugstøl

Constructor Summary
IndexEntry(String newId)
Constructor.
IndexEntry(IndexEntry newParent, String newId)
Constructor.
Method Summary
ListgetChildEntries()
Returns an unmodifiableList of the child entries.
IndexEntrygetFirstEntry()
Returns the first entry.
StringgetId()
Returns the id.
IndexEntrygetLastEntry()
Returns the last entry.
IndexEntrygetNextEntry()
Returns the next entry.
IndexEntrygetParent()
Returns the parent entry.
IndexEntrygetPrevEntry()
Returns the previous entry.
IndexEntrygetRootEntry()
Returns the root entry.
StringgetTitle()
Returns the title.
voidsetChildEntries(List entries)
Sets the child entriesor creates a new ArrayList if entries == null.
voidsetTitle(String newTitle)
Sets the title.
StringtoString()
Returns a string representation of the object.
StringtoString(int depth)
Returns a string representation of all objects to the given depth.

Constructor Detail

IndexEntry

public IndexEntry(String newId)
Constructor.

Parameters: newId The id.

IndexEntry

public IndexEntry(IndexEntry newParent, String newId)
Constructor.

Parameters: newParent The parent. Cannot be null. newId The id. Cannot be null.

Method Detail

getChildEntries

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

Returns: child entries.

getFirstEntry

public IndexEntry getFirstEntry()
Returns the first entry.

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

getId

public String getId()
Returns the id.

Returns: the id.

getLastEntry

public IndexEntry getLastEntry()
Returns the last entry.

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

getNextEntry

public IndexEntry getNextEntry()
Returns the next entry.

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

getParent

public IndexEntry getParent()
Returns the parent entry.

Returns: the parent entry.

getPrevEntry

public IndexEntry getPrevEntry()
Returns the previous entry.

Returns: the previous 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.

getTitle

public String getTitle()
Returns the title.

Returns: the title.

setChildEntries

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

Parameters: entries the entries.

setTitle

public void setTitle(String newTitle)
Sets the title.

Parameters: newTitle the title.

toString

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

Returns: A string.

toString

public 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 © 2002-2011 Apache Software Foundation. All Rights Reserved.