TreeNode.java

Go to the documentation of this file.

package edu.rice.cs.hpc.data.experiment.scope;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/*******************************************************************************
 * Copyright (c) 2005, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/


public class TreeNode {

    private List<TreeNode> children;

    private TreeNode parent;

    protected Object value;

    public TreeNode(final Object value) {
        this.value = value;
    }
    
    public boolean equals(final Object object) {
        if (object instanceof TreeNode) {
            return TreeNode.equals(this.value, ((TreeNode) object).value);
        }

        return false;
    }

    public Object[] getChildren() {
        if (children != null && children.size() > 0) {
            return children.toArray();
        }
        return null;
    }

    public TreeNode getParent() {
        return parent;
    }

    public Object getValue() {
        return value;
    }

    public boolean hasChildren() {
        return children != null && children.size() > 0;
    }
    
    public int hashCode() {
        return TreeNode.hashCode(value);
    }

    /***
     * Add a new child
     * 
     * @param child : child to be added
     */
    public void add(TreeNode child)
    {
        if (children == null) {
            children = new ArrayList<TreeNode>();
        }
        children.add(child);
    }
    
    public void remove(TreeNode child)
    {
        children.remove(child);
    }
    
    
    public void remove(int index)
    {
        children.remove(index);
    }
    
    public void setParent(final TreeNode parent) {
        this.parent = parent;
    }
    
    /***
     * Retrieve a child node of a specific index
     * 
     * @param index
     * 
     * @return TreeNode: a node
     */
    public TreeNode getChildAt(int index) 
    {
        if (children != null) {
            if (index < children.size())
                return children.get(index);
        }
        return null;
    }
    
    /*****
     * Return the number of children
     * 
     * @return
     */
    public int getChildCount() 
    {
        if (children == null)
            return 0;
        return children.size();
    }
    
    public Iterator<TreeNode> getIterator()
    {
        if (children != null)
            return children.iterator();
        else
            return null;
    }
    
    public static final int hashCode(final Object object) {
        return object != null ? object.hashCode() : 0;
    }

    public static final boolean equals(final Object left, final Object right) {
        return left == null ? right == null : ((right != null) && left
                .equals(right));
    }

    /*****
     * free resources
     */
    public void dispose()
    {
        if (children != null)
        {
            children.clear();
            children = null;
        }
        parent   = null;
        value    = null;
    }
}