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

   1 /*
   2  * jSite2 - Tree.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.util.data;
  21
  22 /**
  23  * A tree structure in which every node can have an arbitrary amount of
  24  * children.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  * @param <E>
  28  *            The type of the element to store
  29  */
  30 public class Tree<E extends Comparable<E>> {
  31
  32         /** The root node of the tree. */
  33         private final Node<E> rootNode = new NodeImpl<E>();
  34
  35         /**
  36          * Returns the root node of the tree.
  37          *
  38          * @return The root node of the tree
  39          */
  40         public Node<E> getRootNode() {
  41                 return rootNode;
  42         }
  43
  44 }