001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.tree;
031
032import java.io.Serializable;
033import java.util.Iterator;
034import java.util.List;
035
036/**
037 * @author Jonathan Hare
038 *
039 * @param <T> The type of node the tree can hold
040 */
041public interface TreeNode<T> extends Iterable<TreeNode<T>>, Serializable {
042        /***
043         * @return The value held at the node
044         */
045        public abstract T getValue();
046
047        /***
048         * Set the node value
049         * @param obj new value
050         */
051        public abstract void setValue(T obj);
052
053        /***
054         * Add a child node.
055         * @param tn the child node
056         */
057        public abstract void addChild(TreeNode<T> tn);
058        /***
059         * Remove a child node (if it exists)
060         * @param tn the child node to remove
061         */
062        public abstract void removeChild(TreeNode<T> tn);
063
064        /***
065         * Get all children
066         * @return list of tree nodes
067         */
068        public abstract List<TreeNode<T>> getChildren();
069
070        @Override
071        public abstract Iterator<TreeNode<T>> iterator();
072
073        /***
074         * Does this tree node contain no children
075         * @return contains children
076         */
077        public abstract boolean isLeaf();
078}