tapestry-core/src/main/java/org/apache/tapestry5/tree/TreeNode.java

// Copyright 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry5.tree;

import java.util.List;

/**
 * A node within a {@link TreeModel}. In a {@link DefaultTreeModel}, most of the node's information
 * comes via the {@link TreeModelAdapter}.
 * 
 * @param <T>
 *            type of node
 * @since 5.3
 */
public interface TreeNode<T>
{
    /**
     * Returns a string Id for the node that uniquely identifies it.
     * 
     * @return unique string identifying the node
     * @see TreeModel#getById(String)
     */
    String getId();

    /** Returns the value represented by this node. */
    T getValue();

    /**
     * If true, then this node is a leaf node, which never has children (i.e., a file). If false, the node
     * may have children (i.e., a folder).
     * 
     * @return true for leaf nodes, false for folder nodes
     * @see TreeModelAdapter#isLeaf(Object)
     */
    boolean isLeaf();

    /**
     * Returns true if this non-leaf node has child nodes. This will not be invoked for leaf nodes.
     * 
     * @see TreeModelAdapter#hasChildren(Object)
     */
    boolean getHasChildren();

    /**
     * Returns the actual children of this non-leaf node, as additional nodes.
     * 
     * @see TreeModelAdapter#getChildren(Object)
     */
    List<TreeNode<T>> getChildren();

    // TODO: Some way to influence the rendered output (i.e., to display different icons based on
    // file type).

    /**
     * Returns a textual label for the node. Not all UIs will make use of the label, but default UIs will.
     * 
     * @see TreeModelAdapter#getLabel(Object)
     */
    public String getLabel();
}