001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.util;
029
030import java.util.List;
031
032import com.google.common.collect.Lists;
033
034/**
035 * Generic tree node which can contain an object of generic type T as data, and which has a mutable list
036 * of child nodes.
037 *
038 * @param <T> the type of data associated with the tree node
039 */
040public class CmsTreeNode<T> {
041
042    /** The list of child nodes. */
043    private List<CmsTreeNode<T>> m_children = Lists.newArrayList();
044
045    /** The data associated with this node. */
046    private T m_data;
047
048    /**
049     * Adds a child node.<p>
050     *
051     * @param cmsTreeNode the child node to add
052     */
053    public void addChild(CmsTreeNode<T> cmsTreeNode) {
054
055        m_children.add(cmsTreeNode);
056    }
057
058    /**
059     * Gets the (mutable) list of child nodes.<p>
060     *
061     * @return the list of child nodes
062     */
063    public List<CmsTreeNode<T>> getChildren() {
064
065        return m_children;
066    }
067
068    /**
069     * Gets the data associated with this node.<p>
070     *
071     * @return the data for this node
072     */
073    public T getData() {
074
075        return m_data;
076    }
077
078    /**
079     * Sets the data for this node.<p>
080     *
081     * @param data the data to set
082     */
083    public void setData(T data) {
084
085        m_data = data;
086    }
087
088}