com.phloc.commons.tree.withid.unique.ITreeItemWithUniqueIDFactory Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 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.unique;
import java.util.Collection;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.tree.withid.ITreeItemWithID;
import com.phloc.commons.tree.withid.ITreeItemWithIDFactory;
/**
* An abstract tree item factory that maintains a unique ID over all items!
*
* @author Philip Helger
*/
public interface ITreeItemWithUniqueIDFactory > extends
ITreeItemWithIDFactory
{
/**
* Check if an item with the given ID is contained.
*
* @param aDataID
* The data ID to look up.
* @return true if such an item is contained, false
* otherwise.
*/
boolean containsItemWithDataID (@Nullable KEYTYPE aDataID);
/**
* Try to retrieve the stored item with the given ID.
*
* @param aDataID
* The data ID to look up.
* @return null if no such item is contained, the item otherwise.
*/
@Nullable
ITEMTYPE getItemOfDataID (@Nullable KEYTYPE aDataID);
/**
* @return A collection that contains all items created by this factory
* instance.
*/
@Nonnull
@ReturnsMutableCopy
Collection getAllItems ();
/**
* @return A collection that contains all item datas created by this factory
* instance.
*/
@Nonnull
@ReturnsMutableCopy
Collection getAllItemDatas ();
}