Restructured Mage module

Mage/src/main/java/mage/util/TreeNode.java

@@ -0,0 +1,123 @@
+/*
+ *  Copyright 2010 BetaSteward_at_googlemail.com. All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without modification, are
+ *  permitted provided that the following conditions are met:
+ *
+ *     1. Redistributions of source code must retain the above copyright notice, this list of
+ *        conditions and the following disclaimer.
+ *
+ *     2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *        of conditions and the following disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY BetaSteward_at_googlemail.com ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BetaSteward_at_googlemail.com OR
+ *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ *  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *  The views and conclusions contained in the software and documentation are those of the
+ *  authors and should not be interpreted as representing official policies, either expressed
+ *  or implied, of BetaSteward_at_googlemail.com.
+ */
+package mage.util;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ *
+ * @author BetaSteward_at_googlemail.com
+ * @param <T>
+ */
+public class TreeNode<T> {
+
+    protected T data;
+    protected List<TreeNode<T>> children;
+
+    public TreeNode() {
+        super();
+        children = new ArrayList<>();
+    }
+
+    public TreeNode(T data) {
+        this();
+        setData(data);
+    }
+
+    public List<TreeNode<T>> getChildren() {
+        return this.children;
+    }
+
+    public int getNumberOfChildren() {
+        return getChildren().size();
+    }
+
+    public boolean hasChildren() {
+        return (getNumberOfChildren() > 0);
+    }
+
+    public void setChildren(List<TreeNode<T>> children) {
+        this.children = children;
+    }
+
+    public void addChild(TreeNode<T> child) {
+        children.add(child);
+    }
+
+    public void addChild(T child) {
+        children.add(new TreeNode<>(child));
+    }
+
+    public void addChildAt(int index, TreeNode<T> child) throws IndexOutOfBoundsException {
+        children.add(index, child);
+    }
+
+    public void removeChildren() {
+        this.children.clear();
+    }
+
+    public void removeChildAt(int index) throws IndexOutOfBoundsException {
+        children.remove(index);
+    }
+
+    public TreeNode<T> getChildAt(int index) throws IndexOutOfBoundsException {
+        return children.get(index);
+    }
+
+    public T getData() {
+        return this.data;
+    }
+
+    private void setData(T data) {
+        this.data = data;
+    }
+
+    @Override
+    public String toString() {
+        return getData().toString();
+    }
+
+    @Override
+    public int hashCode() {
+        return getData().hashCode();
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        final TreeNode<T> other = (TreeNode<T>) obj;
+        return !(this.data != other.data && (this.data == null || !this.data.equals(other.data)));
+    }
+
+}