com.phloc.commons.tree.withid.BasicTreeWithID Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation

phloc very basic stuff

There is a newer version: 5.0.0

/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.commons.tree.withid;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.NotThreadSafe;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;

/**
 * Base class for a tree having items with IDs. This implementation is
 * independent of the item implementation class. The elements of the tree are
 * not sorted by any means.
 * 
 * @author Philip Helger
 * @param 
 *        tree item key type
 * @param 
 *        tree item value type
 * @param 
 *        tree item implementation type
 */
@NotThreadSafe
public class BasicTreeWithID > implements ITreeWithID 
{
  // Root item.
  private final ITEMTYPE m_aRoot;

  public BasicTreeWithID (@Nonnull final ITreeItemWithIDFactory  aFactory)
  {
    ValueEnforcer.notNull (aFactory, "Factory");

    m_aRoot = aFactory.createRoot ();
    if (m_aRoot == null)
      throw new IllegalStateException ("Failed to create root item!");
    if (m_aRoot.getParent () != null)
      throw new IllegalStateException ("Create root item has a non-null parent!!!");
  }

  @Nonnull
  public final ITEMTYPE getRootItem ()
  {
    return m_aRoot;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final BasicTreeWithID  rhs = (BasicTreeWithID ) o;
    return m_aRoot.equals (rhs.m_aRoot);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_aRoot).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("root", m_aRoot).toString ();
  }
}