com.helger.tree.IBasicTree Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-tree Show documentation

Java 1.8+ Library with tree structures

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.tree;

import javax.annotation.Nonnull;

import com.helger.commons.hierarchy.IHasChildren;

/**
 * Base interface for a tree.
 *
 * @param 
 *        tree item value type
 * @param 
 *        tree item implementation type
 * @author Philip Helger
 */
public interface IBasicTree > extends IHasChildren 
{
  /**
   * @return The root item of the tree. Never null. The root item
   *         should not be displayed but it is the parent node of all displayed
   *         root items and therefore cannot be removed.
   */
  @Nonnull
  ITEMTYPE getRootItem ();
}