com.phloc.commons.tree.withid.ITreeItemWithID Maven / Gradle / Ivy
/**
* 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 java.util.Comparator;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.id.IHasID;
import com.phloc.commons.state.EChange;
import com.phloc.commons.tree.IBasicTreeItem;
/**
* Represents a basic tree item with an ID. Never use this class directly but
* provide a sub interface that specifies the generic T parameter.
*
* @author Philip Helger
* @param
* The type of the ID.
* @param
* The type of the value.
* @param
* The implementation type.
*/
public interface ITreeItemWithID > extends IBasicTreeItem , IHasID
{
/**
* @return The factory used to create instances of this interface.
*/
@Nonnull
ITreeItemWithIDFactory getFactory ();
/**
* @return The data ID of this item. May be null depending on the
* validator.
*/
KEYTYPE getID ();
/**
* @return The data ID of the parent item. May be null if no
* parent is present or depending on the validator.
*/
KEYTYPE getParentID ();
/**
* @return A set with the data IDs of all children. If this tree item does not
* have children, null if returned.
*/
@Nullable
@ReturnsMutableCopy
Set getAllChildDataIDs ();
/**
* Check if a direct child item with the given ID is present
*
* @param aDataID
* The ID to search. May be null.
* @return true if this item has a child with the given ID,
* false otherwise
*/
boolean containsChildItemWithDataID (@Nullable KEYTYPE aDataID);
/**
* Find the direct child item with the given ID
*
* @param aDataID
* The ID to search. May be null.
* @return null if this item has no child with the given ID. The
* item otherwise.
*/
@Nullable
ITEMTYPE getChildItemOfDataID (@Nullable KEYTYPE aDataID);
/**
* Add an existing direct child to this tree item. Use only internally!
*
* @param aDataID
* The data ID to use. May not be null.
* @param aChild
* The child to be added. May not be null.
* @param bAllowOverwrite
* if true existing elements are overwritten.
* @return {@link EChange}
*/
@Nonnull
EChange internalAddChild (@Nonnull KEYTYPE aDataID, @Nonnull ITEMTYPE aChild, boolean bAllowOverwrite);
/**
* Add a direct child item to this item. If another item with the same ID is
* already contained, the item is automatically overwritten.
*
* @param aDataID
* ID of the item to generate. May be null in rare
* circumstances.
* @param aData
* The data associated with this item.
* @return the created tree item
*/
@Nonnull
ITEMTYPE createChildItem (@Nullable final KEYTYPE aDataID, @Nullable final DATATYPE aData);
/**
* Add a direct child item to this item.
*
* @param aDataID
* ID of the item to generate. May not be null.
* @param aData
* The data associated with this item.
* @param bAllowOverwrite
* If true a potential existing child item with the same
* ID is overwritten.
* @return the created tree item or null if the data ID is
* already in use and bAllowOverwrite is false
*/
@Nullable
ITEMTYPE createChildItem (KEYTYPE aDataID, DATATYPE aData, boolean bAllowOverwrite);
/**
* Remove the passed node as a direct child node from this node.
*
* @param aDataID
* The ID of the element to be removed. May not be nullnull.
*/
void reorderChildrenByItems (@Nonnull Comparator aComparator);
}