net.tridentsdk.meta.component

Interface MetaCollection<S>

All Known Implementing Classes:

ImmutableMetaCollection

@ThreadSafe
public interface MetaCollection<S>

Represents a collection of Meta objects

Since:

0.4-alpha

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the meta collection of meta values
<T extends Meta<S>> boolean	contains(Class<T> cls) Obtains whether a mapping of the type provided exists within the collection
<T extends Meta<S>> T	get(Class<T> cls) Obtains the metadata value from the component type specified
void	iterate(java.util.function.Consumer<Map.Entry<Class<? extends Meta<S>>,Meta<S>>> consumer) Iterates the collection
<T extends Meta<S>> void	put(Class<T> cls, T meta) Puts a mapping of a meta class and the meta value into the collection, replacing the existing value if necessary
<T extends Meta<S>> void	put(T meta) Puts the meta value into the collection, inferring the type
<T extends Meta<S>> boolean	putIfAbsent(Class<T> cls, T meta) Appends the meta mapping only if it does not already exist as defined by contains(Class).
<T extends Meta<S>> boolean	putIfAbsent(T meta) Puts the meta value into the collection if it does not exist as defined by contains(Class)
<T extends Meta<S>> T	remove(Class<T> cls) Removes the meta tag from this collection

Method Detail

get

<T extends Meta<S>> T get(Class<T> cls)

Obtains the metadata value from the component type specified

Type Parameters:

T - the meta value type

Parameters:

cls - the component type

Returns:

the meta value

put

<T extends Meta<S>> void put(T meta)

Puts the meta value into the collection, inferring the type

Type Parameters:

T - the meta type

Parameters:

meta - the meta to put

putIfAbsent

<T extends Meta<S>> boolean putIfAbsent(T meta)

Puts the meta value into the collection if it does not exist as defined by contains(Class)

Type Parameters:

T - the meta type

Parameters:

meta - the meta value to put

Returns:

true if the operation changed the collection, false if it had no effect

put

<T extends Meta<S>> void put(Class<T> cls,
                             T meta)

Puts a mapping of a meta class and the meta value into the collection, replacing the existing value if necessary

Type Parameters:

T - the meta value type

Parameters:

cls - the meta type

meta - the meta value

putIfAbsent

<T extends Meta<S>> boolean putIfAbsent(Class<T> cls,
                                        T meta)

Appends the meta mapping only if it does not already exist as defined by contains(Class). Otherwise has no effect.

Type Parameters:

T - the meta value type

Parameters:

cls - the meta type

meta - the meta value

Returns:

true if this operation changed the collection, false if it had no effect

contains

<T extends Meta<S>> boolean contains(Class<T> cls)

Obtains whether a mapping of the type provided exists within the collection

Type Parameters:

T - the meta value type

Parameters:

cls - the meta type

Returns:

true if it exists, false if it doesn't

remove

<T extends Meta<S>> T remove(Class<T> cls)

Removes the meta tag from this collection

Type Parameters:

T - the meta value type

Parameters:

cls - the meta type to remove

Returns:

the meta value associated with the type, or null if this operation had no effect

iterate

void iterate(java.util.function.Consumer<Map.Entry<Class<? extends Meta<S>>,Meta<S>>> consumer)

Iterates the collection

Parameters:

consumer - the iteration function

clear

void clear()

Clear the meta collection of meta values