src/net/pterodactylus/util/data/Node.java

   1
   2 package net.pterodactylus.util.data;
   3
   4 import java.util.Iterator;
   5
   6 /**
   7  * A node that can be stored in a {@link Tree}. A node has exactly one parent
   8  * (which is <code>null</code> if the node is the {@link Tree#getRootNode()}
   9  * of the tree) and an arbitrary amount of child nodes.
  10  *
  11  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  12  * @param <E>
  13  *            The type of the element to store
  14  */
  15 public interface Node<E> extends Iterable<Node<E>> {
  16
  17         /**
  18          * Returns the parent node of the node.
  19          *
  20          * @return The parent node
  21          */
  22         public Node<E> getParent();
  23
  24         /**
  25          * Returns the element that is stored in the node.
  26          *
  27          * @return The node’s element
  28          */
  29         public E getElement();
  30
  31         /**
  32          * Adds an element as a child to this node and returns the created node.
  33          *
  34          * @param child
  35          *            The child node’s element
  36          * @return The created child node
  37          */
  38         public Node<E> addChild(E child);
  39
  40         /**
  41          * Returns the number of children this node has.
  42          *
  43          * @return The number of children
  44          */
  45         public int size();
  46
  47         /**
  48          * Returns the child at the given index.
  49          *
  50          * @param index
  51          *            The index of the child
  52          * @return The child at the given index
  53          */
  54         public Node<E> getChild(int index);
  55
  56         /**
  57          * Returns whether the given node is a direct child of this node.
  58          *
  59          * @param childNode
  60          *            The child node
  61          * @return <code>true</code> if the given node is a direct child of this
  62          *         node, <code>false</code> otherwise
  63          */
  64         public boolean hasChild(Node<E> childNode);
  65
  66         /**
  67          * Returns whether this node contains a child node containing the given
  68          * element.
  69          *
  70          * @param element
  71          *            The element
  72          * @return <code>true</code> if this node contains a direct child node
  73          *         containing the given element, <code>false</code> otherwise
  74          */
  75         public boolean hasChild(E element);
  76
  77         /**
  78          * Returns the index of the given child node.
  79          *
  80          * @param childNode
  81          *            The child node
  82          * @return The index of the child node, or <code>-1</code> if the child
  83          *         node is not a child node of this node
  84          */
  85         public int getIndexOfChild(Node<E> childNode);
  86
  87         /**
  88          * Returns the index of the child node containing the given element.
  89          *
  90          * @param element
  91          *            The element
  92          * @return The index of the child node, or <code>-1</code> if the child
  93          *         node is not a child node of this node
  94          */
  95         public int getIndexOfChild(E element);
  96
  97         /**
  98          * Remove the given child node from this node. If the given node is not a
  99          * child of this node, nothing happens.
 100          *
 101          * @param childNode
 102          *            The child node to remove
 103          */
 104         public void removeChild(Node<E> childNode);
 105
 106         /**
 107          * Removes the child node that contains the given element. The element in
 108          * the node is checked using {@link Object#equals(Object)}.
 109          *
 110          * @param child
 111          *            The child element to remove
 112          */
 113         public void removeChild(E child);
 114
 115         /**
 116          * Removes the child at the given index.
 117          *
 118          * @param childIndex
 119          *            The index of the child to remove
 120          */
 121         public void removeChild(int childIndex);
 122
 123         /**
 124          * Removes all children from this node.
 125          */
 126         public void removeAllChildren();
 127
 128         /**
 129          * {@inheritDoc}
 130          */
 131         public Iterator<Node<E>> iterator();
 132
 133         /**
 134          * Searches this node’s children recursively for a node that contains the
 135          * given element.
 136          *
 137          * @param element
 138          *            The element to search
 139          * @return The node that contains the given element, or <code>null</code>
 140          *         if no node could be found
 141          */
 142         public Node<E> findChild(E element);
 143
 144 }