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          * Remove the given child node from this node. If the given node is not a
  58          * child of this node, nothing happens.
  59          *
  60          * @param childNode
  61          *            The child node to remove
  62          */
  63         public void removeChild(Node<E> childNode);
  64
  65         /**
  66          * Removes the child node that contains the given element. The element in
  67          * the node is checked using {@link Object#equals(Object)}.
  68          *
  69          * @param child
  70          *            The child element to remove
  71          */
  72         public void removeChild(E child);
  73
  74         /**
  75          * Removes the child at the given index.
  76          *
  77          * @param childIndex
  78          *            The index of the child to remove
  79          */
  80         public void removeChild(int childIndex);
  81
  82         /**
  83          * {@inheritDoc}
  84          */
  85         public Iterator<Node<E>> iterator();
  86
  87 }