Package org.cyclops.cyclopscore.ingredient.collection

Class IngredientMapSingleClassified<T,M,V,C>

java.lang.Object

org.cyclops.cyclopscore.ingredient.collection.IngredientMapAdapter<T,M,V>

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

Type Parameters:

T - The instance type.

M - The matching condition parameter.

V - The type of mapped values.

C - The category type.

All Implemented Interfaces:

Iterable<Map.Entry<T,V>>, IIngredientCollectionLike<T,M,Map.Entry<T,V>>, IIngredientCollectionLikeSingleClassifiedTrait<T,M,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>, IIngredientMap<T,M,V>, IIngredientMapMutable<T,M,V>

public class IngredientMapSingleClassified<T,M,V,C>
extends IngredientMapAdapter<T,M,V>
implements IIngredientCollectionLikeSingleClassifiedTrait<T,M,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

An ingredient map 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
IngredientMapSingleClassified(IngredientComponent<T,M> component, Supplier<IIngredientMapMutable<T,M,V>> mapCreator, IngredientComponentCategoryType<T,M,C> categoryType)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this map of all instances.
boolean	containsKey(T instance, M matchCondition)	Check if this map contains the given instance under the given match conditions.
boolean	containsValue(V value)	Check if this map contains the given value.
int	countKey(T instance, M matchCondition)	Count the number of occurrences of the given instance under the given match conditions.
IIngredientMapMutable<T,M,V>	createEmptyCollection()
V	get(T key)	Get the value for the given instance.
Collection<V>	getAll(T key, M matchCondition)	Get all values for all instances that match with the given instance under the given match conditions.
IngredientComponentCategoryType<T,M,C>	getCategoryType()
Map<C,IIngredientMapMutable<T,M,V>>	getClassifiedCollections()
T	getInstance(Map.Entry<T,V> iterableInstance)	Get the instance from the given iterator instance.
Iterator<Map.Entry<T,V>>	iterator()
Iterator<Map.Entry<T,V>>	iterator(T instance, M matchCondition)	An iterator over this collection over all occurrences of the given instance under the given match conditions.
IngredientSet<T,M>	keySet()
IngredientSet<T,M>	keySet(T key, M matchCondition)	Get all key instances that match the given instance.
V	put(T key, V value)	Add a new entry.
V	remove(T key)	Remove the mapping for the given key instance.
void	setSize(int size)	Set the internal size value.
int	size()
Collection<V>	values()

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

entrySet, equals, getComponent, hashCode, removeAll, 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.IIngredientCollectionLike

equals, 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.IIngredientMap

containsKey, containsKeyAll, containsKeyAll

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

putAll, removeAll, removeAll

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

IngredientMapSingleClassified

public IngredientMapSingleClassified(IngredientComponent<T,M> component,
 Supplier<IIngredientMapMutable<T,M,V>> mapCreator,
 IngredientComponentCategoryType<T,M,C> categoryType)

Create a new instance.

Parameters:

component - A component type.

mapCreator - A callback for creating new internal maps 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,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

Returns:

The category type using which this collection classifies.

createEmptyCollection

public IIngredientMapMutable<T,M,V> createEmptyCollection()

Specified by:

createEmptyCollection in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

Returns:

A new collection-like for internal classification usage.

getInstance

public T getInstance(Map.Entry<T,V> 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,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

Parameters:

iterableInstance - An iterator instance.

Returns:

An instance.

getClassifiedCollections

public Map<C,IIngredientMapMutable<T,M,V>> getClassifiedCollections()

Specified by:

getClassifiedCollections in interface IIngredientCollectionLikeSingleClassifiedTrait<T,M,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

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,Map.Entry<T,V>,C,IIngredientMapMutable<T,M,V>>

Parameters:

size - The new size.

clear

public void clear()

Description copied from interface: IIngredientMapMutable

Clears this map of all instances.

Specified by:

clear in interface IIngredientMapMutable<T,M,V>

put

@Nullable
public V put(T key,
 V value)

Description copied from interface: IIngredientMapMutable

Add a new entry.

Specified by:

put in interface IIngredientMapMutable<T,M,V>

Parameters:

key - An instance key.

value - A value.

Returns:

The previous value that was associated with the given instance.

remove

@Nullable
public V remove(T key)

Description copied from interface: IIngredientMapMutable

Remove the mapping for the given key instance.

Specified by:

remove in interface IIngredientMapMutable<T,M,V>

Parameters:

key - An instance key.

Returns:

The value that was associated with the given instance.

size

public int size()

Specified by:

size in interface IIngredientCollectionLike<T,M,V>

Returns:

The number of instances contained in this collection.

containsKey

public boolean containsKey(T instance,
 M matchCondition)

Description copied from interface: IIngredientMap

Check if this map 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:

containsKey in interface IIngredientMap<T,M,V>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

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

countKey

public int countKey(T instance,
 M matchCondition)

Description copied from interface: IIngredientMap

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:

countKey in interface IIngredientMap<T,M,V>

Parameters:

instance - An instance.

matchCondition - A match condition.

Returns:

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

containsValue

public boolean containsValue(V value)

Description copied from interface: IIngredientMap

Check if this map contains the given value.

Specified by:

containsValue in interface IIngredientMap<T,M,V>

Parameters:

value - A value.

Returns:

If this map contains the given value.

get

@Nullable
public V get(T key)

Description copied from interface: IIngredientMap

Get the value for the given instance.

Specified by:

get in interface IIngredientMap<T,M,V>

Parameters:

key - An instance.

Returns:

The value.

keySet

public IngredientSet<T,M> keySet()

Specified by:

keySet in interface IIngredientMap<T,M,V>

Returns:

All key instances.

values

public Collection<V> values()

Specified by:

values in interface IIngredientMap<T,M,V>

Returns:

All values.

getAll

public Collection<V> getAll(T key,
 M matchCondition)

Description copied from interface: IIngredientMap

Get all values for all instances that match with 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:

getAll in interface IIngredientMap<T,M,V>

Overrides:

getAll in class IngredientMapAdapter<T,M,V>

Parameters:

key - An instance.

matchCondition - A match condition.

Returns:

All matching values.

keySet

public IngredientSet<T,M> keySet(T key,
 M matchCondition)

Description copied from interface: IIngredientMap

Get all key instances that match the given instance. This instance will be compared based on the matcher from the ingredient component type using the given match condition.

Specified by:

keySet in interface IIngredientMap<T,M,V>

Overrides:

keySet in class IngredientMapAdapter<T,M,V>

Parameters:

key - An instance.

matchCondition - A match condition.

Returns:

All key instances that match the given instance.

iterator

public Iterator<Map.Entry<T,V>> iterator()

Specified by:

iterator in interface Iterable<T>

iterator

public Iterator<Map.Entry<T,V>> iterator(T instance,
 M matchCondition)

Description copied from interface: IIngredientCollectionLike

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

Specified by:

iterator in interface IIngredientCollectionLike<T,M,V>

Overrides:

iterator in class IngredientMapAdapter<T,M,V>

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.