com.rapiddweller.common.tree.DefaultTreeNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation

'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.

There is a newer version: 2.0.1-jdk-11

Show newest version

/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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 com.rapiddweller.common.tree;

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

/**
 * Default implementation of a tree node.
 * Created: 08.05.2007 19:06:49
 *
 * @param  the type of the wrapped object
 * @author Volker Bergmann
 */
public class DefaultTreeNode {

  private final DefaultTreeNode parent;
  private final boolean leaf;
  private final List> children;
  /**
   * The Object.
   */
  protected E object;

  /**
   * Create leaf default tree node.
   *
   * @param     the type parameter
   * @param parent the parent
   * @param object the object
   * @return the default tree node
   */
  public static  DefaultTreeNode createLeaf(DefaultTreeNode parent, T object) {
    return new DefaultTreeNode<>(parent, object, true);
  }

  /**
   * Create folder default tree node.
   *
   * @param     the type parameter
   * @param parent the parent
   * @param object the object
   * @return the default tree node
   */
  public static  DefaultTreeNode createFolder(DefaultTreeNode parent, T object) {
    return new DefaultTreeNode<>(parent, object, false);
  }

  /**
   * Instantiates a new Default tree node.
   *
   * @param object the object
   */
  public DefaultTreeNode(E object) {
    this(null, object);
  }

  /**
   * Instantiates a new Default tree node.
   *
   * @param parent the parent
   * @param object the object
   */
  public DefaultTreeNode(DefaultTreeNode parent, E object) {
    this(parent, object, false);
  }

  /**
   * Instantiates a new Default tree node.
   *
   * @param parent the parent
   * @param object the object
   * @param leaf   the leaf
   */
  public DefaultTreeNode(DefaultTreeNode parent, E object, boolean leaf) {
    this.parent = parent;
    this.leaf = leaf;
    this.children = new ArrayList<>();
    this.object = object;
  }

  /**
   * Add child.
   *
   * @param child the child
   */
  public void addChild(DefaultTreeNode child) {
    if (leaf) {
      throw new IllegalStateException("Can't add a child to a leaf");
    }
    children.add(child);
  }

  /**
   * Gets parent.
   *
   * @return the parent
   */
  public DefaultTreeNode getParent() {
    return parent;
  }

  /**
   * Gets child.
   *
   * @param index the index
   * @return the child
   */
  public DefaultTreeNode getChild(int index) {
    return children.get(index);
  }

  /**
   * Gets child count.
   *
   * @return the child count
   */
  public int getChildCount() {
    return children.size();
  }

  /**
   * Is leaf boolean.
   *
   * @return the boolean
   */
  public boolean isLeaf() {
    return leaf;
  }

  /**
   * Gets index of child.
   *
   * @param child the child
   * @return the index of child
   */
  public int getIndexOfChild(DefaultTreeNode child) {
    return children.indexOf(child);
  }

  /**
   * Gets object.
   *
   * @return the object
   */
  public E getObject() {
    return object;
  }

  @Override
  public String toString() {
    return String.valueOf(object);
  }
}