Class DocumentTOC

java.lang.Object
org.apache.maven.doxia.document.DocumentTOC
All Implemented Interfaces:
Serializable

public class DocumentTOC extends Object implements Serializable
A Table Of Content for the document.
Version:
$Revision$ $Date$
See Also:
  • Field Details

    • name

      private String name
      The name to use for the Table of Contents.
    • depth

      private int depth
      The level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.
    • items

      private List<DocumentTOCItem> items
      Field items.
  • Constructor Details

    • DocumentTOC

      public DocumentTOC()
  • Method Details

    • addItem

      public void addItem(DocumentTOCItem documentTOCItem)
      Method addItem.
      Parameters:
      documentTOCItem - a documentTOCItem object.
    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean
    • getDepth

      public int getDepth()
      Get the level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.
      Returns:
      int
    • getItems

      public List<DocumentTOCItem> getItems()
      Method getItems.
      Returns:
      List
    • getName

      public String getName()
      Get the name to use for the Table of Contents.
      Returns:
      String
    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int
    • removeItem

      public void removeItem(DocumentTOCItem documentTOCItem)
      Method removeItem.
      Parameters:
      documentTOCItem - a documentTOCItem object.
    • setDepth

      public void setDepth(int depth)
      Set the level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.
      Parameters:
      depth - a depth object.
    • setItems

      public void setItems(List<DocumentTOCItem> items)
      Set tOC item.
      Parameters:
      items - a items object.
    • setName

      public void setName(String name)
      Set the name to use for the Table of Contents.
      Parameters:
      name - a name object.
    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String