Package org.cyclops.cyclopscore.ingredient.collection

Class IngredientCollectionCollectionWrappedAdapter<T,M,C extends Collection<IngredientInstanceWrapper<T,M>>>

java.lang.Object

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

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

Type Parameters:

T - The instance type.

M - The matching condition parameter.

C - The type of collection that will contain the wrappers.

All Implemented Interfaces:

Iterable<T>, IIngredientCollection<T,M>, IIngredientCollectionLike<T,M,T>, IIngredientCollectionMutable<T,M>

Direct Known Subclasses:

IngredientSet

public abstract class IngredientCollectionCollectionWrappedAdapter<T,M,C extends Collection<IngredientInstanceWrapper<T,M>>>
extends IngredientCollectionAdapter<T,M>
implements IIngredientCollectionMutable<T,M>

An abstract collection that wraps instances in a IngredientInstanceWrapper and stores those in a regular Collection.

Constructor Summary

Constructors

Constructor	Description
IngredientCollectionCollectionWrappedAdapter(IngredientComponent<T,M> component, C collection)

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.
protected C	getCollection()
Iterator<T>	iterator()
boolean	remove(T instance)	Remove the given instance from the collection.
int	size()
protected IngredientInstanceWrapper<T,M>	wrap(T instance)

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

contains, count, getComponent, hashCode, iterator, removeAll, toString

Methods inherited from class java.lang.Object

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

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

contains, containsAll, containsAll, count, iterator, parallelStream, spliterator, stream, toArray

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

equals, getComponent, hashCode, isEmpty, toString

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

addAll, removeAll, removeAll, removeAll

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

IngredientCollectionCollectionWrappedAdapter

public IngredientCollectionCollectionWrappedAdapter(IngredientComponent<T,M> component,
 C collection)

Method Details

getCollection

protected C getCollection()

wrap

protected IngredientInstanceWrapper<T,M> wrap(T instance)

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.

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.

clear

public void clear()

Description copied from interface: IIngredientCollectionMutable

Clears this collection of all instances.

Specified by:

clear in interface IIngredientCollectionMutable<T,M>

size

public int size()

Specified by:

size in interface IIngredientCollectionLike<T,M,C extends Collection<IngredientInstanceWrapper<T,M>>>

Returns:

The number of instances contained in this collection.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>