Package org.docx4j.model.styles

Class Tree<T>

java.lang.Object
org.docx4j.model.styles.Tree<T>
public class Tree<T>
extends java.lang.Object
Represents a Tree of Objects of generic type T. The Tree is represented as a single rootElement which points to a List> of children. There is no restriction on the number of children that a particular node may have. This Tree provides a method to serialize the Tree into a List by doing a pre-order traversal. It has several methods to allow easy updation of Nodes in the Tree. Original code from http://sujitpal.blogspot.com/2006/05/java-data-structure-generic-tree.html

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.util.Map<java.lang.String,​java.lang.Object> nodes  

  • Constructor Summary

    Constructors 
    Constructor Description
    Tree()  

  • Method Summary

    Modifier and Type Method Description
    java.util.List<Node<T>> climb​(Node<T> n)  
    Node<T> get​(java.lang.String name)
    Quick access to any node in the tree.
    Node<T> getRootElement()
    Return the root Node of the tree.
    void setRootElement​(Node<T> rootElement)
    Set the root Element for the tree.
    java.util.List<Node<T>> toList()
    Returns the Tree as a List of Node objects.
    java.lang.String toString()
    Returns a String representation of the Tree.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • nodes

      protected java.util.Map<java.lang.String,​java.lang.Object> nodes

  • Constructor Details

    • Tree

      public Tree()

  • Method Details

    • get

      public Node<T> get​(java.lang.String name)
      Quick access to any node in the tree.
      Parameters:
      name -
      Returns:

    • getRootElement

      public Node<T> getRootElement()
      Return the root Node of the tree.
      Returns:
      the root element.

    • setRootElement

      public void setRootElement​(Node<T> rootElement)
      Set the root Element for the tree.
      Parameters:
      rootElement - the root element to set.

    • toList

      public java.util.List<Node<T>> toList()
      Returns the Tree as a List of Node objects. The elements of the List are generated from a pre-order traversal of the tree.
      Returns:
      a List>.

    • toString

      public java.lang.String toString()
      Returns a String representation of the Tree. The elements are generated from a pre-order traversal of the Tree.
      Overrides:
      toString in class java.lang.Object
      Returns:
      the String representation of the Tree.

    • climb

      public java.util.List<Node<T>> climb​(Node<T> n)