DocumentTOC (Doxia 1.7 API)

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:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentTOC()

Constructors
Constructor and Description
`DocumentTOC()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addItem(DocumentTOCItem documentTOCItem)` Method addItem.
`boolean`	`equals(Object other)` Method equals.
`int`	`getDepth()` Get the level up to which toc items are included by default.
`List<DocumentTOCItem>`	`getItems()` Method getItems.
`String`	`getName()` Get the name to use for the Table of Contents.
`int`	`hashCode()` Method hashCode.
`void`	`removeItem(DocumentTOCItem documentTOCItem)` Method removeItem.
`void`	`setDepth(int depth)` Set the level up to which toc items are included by default.
`void`	`setItems(List<DocumentTOCItem> items)` Set tOC item.
`void`	`setName(String name)` Set the name to use for the Table of Contents.
`String`	`toString()` Method toString.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentTOC
```
public DocumentTOC()
```
- Method Detail
  - addItem
```
public void addItem(DocumentTOCItem documentTOCItem)
```
    Method addItem.
    
    Parameters:
    documentTOCItem -
  - equals
```
public boolean equals(Object other)
```
    Method equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
    
    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 -
  - 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 -
  - setItems
```
public void setItems(List<DocumentTOCItem> items)
```
    Set tOC item.
    
    Parameters:
    items -
  - setName
```
public void setName(String name)
```
    Set the name to use for the Table of Contents.
    
    Parameters:
    name -
  - toString
```
public String toString()
```
    Method toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class DocumentTOC

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentTOC

Method Detail

addItem

equals

getDepth

getItems

getName

hashCode

removeItem

setDepth

setItems

setName

toString