Package org.cyclops.cyclopscore.ingredient.collection

Class IngredientCollectionSingleClassified<T,M,C,L extends IIngredientCollectionMutable<T,M>>

java.lang.Object

org.cyclops.cyclopscore.ingredient.collection.IngredientCollectionAdapter<T,M>

org.cyclops.cyclopscore.ingredient.collection.IngredientCollectionSingleClassified<T,M,C,L>

Type Parameters:

T - An instance type.

M - The matching condition parameter.

C - A classifier type.

L - The inner collection type.

All Implemented Interfaces:

Iterable<T>, IIngredientCollection<T,M>, IIngredientCollectionLike<T,M,T>, IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L>, IIngredientCollectionMutable<T,M>

Direct Known Subclasses:

IngredientCollectionSingleClassifiedCollapsed

public class IngredientCollectionSingleClassified<T,M,C,L extends IIngredientCollectionMutable<T,M>>
extends IngredientCollectionAdapter<T,M>
implements IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L>

An ingredient collection that classifies instances in smaller collections based on a category type. This allows instances to be looked up or removed more efficiently when the used match condition is compatible with the identifying match condition of the configured category type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cyclops.cyclopscore.ingredient.collection.IIngredientCollectionLikeSingleClassifiedTrait

IIngredientCollectionLikeSingleClassifiedTrait.ClassifiedIterator<T,M,I,C,L extends IIngredientCollectionLike<T,M,I>>, IIngredientCollectionLikeSingleClassifiedTrait.ClassifiedIteratorDelegated<T,M,C,I,L extends IIngredientCollectionLike<T,M,I>>

Constructor Summary

Constructors

Constructor	Description
IngredientCollectionSingleClassified(IngredientComponent<T,M> component, Supplier<L> collectionCreator, IngredientComponentCategoryType<T,M,C> categoryType)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	add(T instance)	Add the given instance to the collection.
void	clear()	Clears this collection of all instances.
boolean	contains(T instance)	Check if this collection contains the given instance.
boolean	contains(T instance, M matchCondition)	Check if this collection contains the given instance under the given match conditions.
int	count(T instance, M matchCondition)	Count the number of occurrences of the given instance under the given match conditions.
L	createEmptyCollection()
boolean	equals(Object obj)	Check if this collection equals the given object.
IngredientComponentCategoryType<T,M,C>	getCategoryType()
Map<C,L>	getClassifiedCollections()
T	getInstance(T iterableInstance)	Get the instance from the given iterator instance.
Iterator<T>	iterator()
Iterator<T>	iterator(T instance, M matchCondition)	An iterator over this collection over all occurrences of the given instance under the given match conditions.
boolean	remove(T instance)	Remove the given instance from the collection.
int	removeAll(T instance, M matchCondition)	Remove all occurrences of the given instance under the given match conditions.
void	setSize(int size)	Set the internal size value.
int	size()

Methods inherited from class org.cyclops.cyclopscore.ingredient.collection.IngredientCollectionAdapter

getComponent, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclops.cyclopscore.ingredient.collection.IIngredientCollection

containsAll, containsAll, parallelStream, spliterator, stream, toArray

Methods inherited from interface org.cyclops.cyclopscore.ingredient.collection.IIngredientCollectionLike

getComponent, hashCode, isEmpty, toString

Methods inherited from interface org.cyclops.cyclopscore.ingredient.collection.IIngredientCollectionLikeSingleClassifiedTrait

appliesToClassifier, getClassifier, getOrCreateClassifiedCollection

Methods inherited from interface org.cyclops.cyclopscore.ingredient.collection.IIngredientCollectionMutable

addAll, removeAll, removeAll

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

IngredientCollectionSingleClassified

public IngredientCollectionSingleClassified(IngredientComponent<T,M> component,
 Supplier<L> collectionCreator,
 IngredientComponentCategoryType<T,M,C> categoryType)

Create a new instance.

Parameters:

component - A component type.

collectionCreator - A callback for creating new internal collections for a single classifier.

categoryType - A category type using which this collection will classify instance.

Method Details

getCategoryType

public IngredientComponentCategoryType<T,M,C> getCategoryType()

Specified by:

getCategoryType in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L extends IIngredientCollectionMutable<T,M>>

Returns:

The category type using which this collection classifies.

createEmptyCollection

public L createEmptyCollection()

Specified by:

createEmptyCollection in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L extends IIngredientCollectionMutable<T,M>>

Returns:

A new collection-like for internal classification usage.

getInstance

public T getInstance(T iterableInstance)

Description copied from interface: IIngredientCollectionLikeSingleClassifiedTrait

Get the instance from the given iterator instance. This is used internally for iteration purposes. This typically is just a no-op.

Specified by:

getInstance in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L extends IIngredientCollectionMutable<T,M>>

Parameters:

iterableInstance - An iterator instance.

Returns:

An instance.

getClassifiedCollections

public Map<C,L> getClassifiedCollections()

Specified by:

getClassifiedCollections in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L extends IIngredientCollectionMutable<T,M>>

Returns:

A mapping of all internal classified collections.

setSize

public void setSize(int size)

Description copied from interface: IIngredientCollectionLikeSingleClassifiedTrait

Set the internal size value. This should not be called outside of internal usage, such as custom iterators that can mutate this collection.

Specified by:

setSize in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,T,C,L extends IIngredientCollectionMutable<T,M>>

Parameters:

size - The new size.

size

public int size()

Specified by:

size in interface IIngredientCollectionLike<T,M,C>

Returns:

The number of instances contained in this collection.

add

public boolean add(T instance)

Description copied from interface: IIngredientCollectionMutable

Add the given instance to the collection.

Specified by:

add in interface IIngredientCollectionMutable<T,M>

Parameters:

instance - An instance.

Returns:

If the collection was changed due to this addition. This can be false in the case of sets in which each instance can only exists once.

remove

public boolean remove(T instance)

Description copied from interface: IIngredientCollectionMutable

Remove the given instance from the collection.

Specified by:

remove in interface IIngredientCollectionMutable<T,M>

Overrides:

remove in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

Returns:

If the collection was changed due to this addition. Can be false if the collection did not contain the instance.

removeAll

public int removeAll(T instance,
 M matchCondition)

Description copied from interface: IIngredientCollectionMutable

Remove all occurrences of the given instance under the given match conditions. This instance will be compared based on the matcher from the ingredient component type using the given match condition.

Specified by:

removeAll in interface IIngredientCollectionMutable<T,M>

Overrides:

removeAll in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

The number of removed instances.

contains

public boolean contains(T instance)

Description copied from interface: IIngredientCollection

Check if this collection contains the given instance. This instance will be compared based on the matcher from the ingredient component type.

Specified by:

contains in interface IIngredientCollection<T,M>

Overrides:

contains in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

Returns:

If this collection contains the given instance.

contains

public boolean contains(T instance,
 M matchCondition)

Description copied from interface: IIngredientCollection

Check if this collection contains the given instance under the given match conditions. This instance will be compared based on the matcher from the ingredient component type using the given match condition.

Specified by:

contains in interface IIngredientCollection<T,M>

Overrides:

contains in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

If this collection contains the given instance under the given match conditions.

clear

public void clear()

Description copied from interface: IIngredientCollectionMutable

Clears this collection of all instances.

Specified by:

clear in interface IIngredientCollectionMutable<T,M>

count

public int count(T instance,
 M matchCondition)

Description copied from interface: IIngredientCollection

Count the number of occurrences of the given instance under the given match conditions. This instance will be compared based on the matcher from the ingredient component type using the given match condition.

Specified by:

count in interface IIngredientCollection<T,M>

Overrides:

count in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

The number of occurrences of the given instance under the given match conditions.

equals

public boolean equals(Object obj)

Description copied from interface: IIngredientCollectionLike

Check if this collection equals the given object.

Specified by:

equals in interface IIngredientCollectionLike<T,M,C>

Overrides:

equals in class Object

Parameters:

obj - An object.

Returns:

True if the given object is an ingredient collection of the same type, component type and contains the same instances.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

iterator

public Iterator<T> iterator(T instance,
 M matchCondition)

Description copied from interface: IIngredientCollection

An iterator over this collection over all occurrences of the given instance under the given match conditions.

Specified by:

iterator in interface IIngredientCollection<T,M>

Specified by:

iterator in interface IIngredientCollectionLike<T,M,C>

Overrides:

iterator in class IngredientCollectionAdapter<T,M>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

An iterator over this collection over all occurrences of the given instance under the given match conditions.