Class IndexEntry


  • public class IndexEntry
    extends java.lang.Object

    IndexEntry class.

    Version:
    $Id$
    • Field Detail

      • parent

        private final IndexEntry parent
        The parent entry.
      • id

        private java.lang.String id
        The id of the entry.
      • title

        private java.lang.String title
        The entry title.
      • childEntries

        private java.util.List<IndexEntry> childEntries
        The child entries.
      • EOL

        private static final java.lang.String EOL
        System-dependent EOL.
    • 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.
        Parameters:
        id - 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<IndexEntry> getChildEntries()
        Returns an unmodifiableList of the child entries.
        Returns:
        child entries.
      • setChildEntries

        public void setChildEntries​(java.util.List<IndexEntry> 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.