com.helger.tree.withid.folder.AbstractFolderTreeItemFactory 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.withid.folder;

import java.util.Collection;

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

import com.helger.commons.aggregate.IAggregator;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;
import com.helger.tree.withid.unique.AbstractTreeItemWithUniqueIDFactory;

/**
 * The default folder tree item factory implementation.
 *
 * @author Philip Helger
 * @param 
 *        Key type
 * @param 
 *        Value type
 * @param 
 *        Collection type consisting of value elements
 * @param 
 *        the implementation item type
 */
@NotThreadSafe
public abstract class AbstractFolderTreeItemFactory , ITEMTYPE extends BasicFolderTreeItem >
                                                    extends
                                                    AbstractTreeItemWithUniqueIDFactory 
                                                    implements
                                                    IFolderTreeItemFactory 
{
  private final IAggregator  m_aKeyCombinator;

  protected AbstractFolderTreeItemFactory (@Nullable final IAggregator  aKeyCombinator)
  {
    m_aKeyCombinator = aKeyCombinator;
  }

  @Override
  @Nonnull
  protected final KEYTYPE internalGetItemID (@Nonnull final ITEMTYPE aItem)
  {
    return aItem.getGlobalUniqueDataID ();
  }

  @Nullable
  public final IAggregator  getKeyCombinator ()
  {
    return m_aKeyCombinator;
  }

  @Nonnull
  protected abstract ITEMTYPE internalCreateRoot ();

  /*
   * This implementation is different, because the root object is also put into
   * the item store.
   */
  @Nonnull
  public final ITEMTYPE createRoot ()
  {
    final ITEMTYPE aItem = internalCreateRoot ();
    return addToItemStore (aItem.getGlobalUniqueDataID (), aItem);
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return false;
    final AbstractFolderTreeItemFactory  rhs = (AbstractFolderTreeItemFactory ) o;
    return EqualsHelper.equals (m_aKeyCombinator, rhs.m_aKeyCombinator);
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ()).append (m_aKeyCombinator).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ())
                            .appendIfNotNull ("keyCombinator", m_aKeyCombinator)
                            .getToString ();
  }
}