ImmutableMetaCollection (TridentSDK 0.4-SNAPSHOT API)

java.lang.Object
- net.tridentsdk.meta.component.ImmutableMetaCollection<S>

All Implemented Interfaces:

MetaCollection<S>
```
public class ImmutableMetaCollection<S>
extends Object
implements MetaCollection<S>
```
Represents an immutable view of a metacollection

Since:

0.4-alpha

Author:

The TridentSDK Team

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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
`static <T extends MetaOwner> MetaCollection<T>`	`copyOf(MetaCollection<T> 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 `MetaCollection.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 `MetaCollection.contains(Class)`
`<T extends Meta<S>> T`	`remove(Class<T> cls)` Removes the meta tag from this collection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copyOf
```
public static <T extends MetaOwner> MetaCollection<T> copyOf(MetaCollection<T> collection)
```
  - get
```
public <T extends Meta<S>> T get(Class<T> cls)
```
    Description copied from interface: MetaCollection
    
    Obtains the metadata value from the component type specified
    
    Specified by:
    
    get in interface MetaCollection<S>
    
    Type Parameters:
    
    T - the meta value type
    
    Parameters:
    
    cls - the component type
    
    Returns:
    
    the meta value
  - put
```
public <T extends Meta<S>> void put(T meta)
```
    Description copied from interface: MetaCollection
    
    Puts the meta value into the collection, inferring the type
    
    Specified by:
    
    put in interface MetaCollection<S>
    
    Type Parameters:
    
    T - the meta type
    
    Parameters:
    
    meta - the meta to put
  - putIfAbsent
```
public <T extends Meta<S>> boolean putIfAbsent(T meta)
```
    Description copied from interface: MetaCollection
    
    Puts the meta value into the collection if it does not exist as defined by MetaCollection.contains(Class)
    
    Specified by:
    
    putIfAbsent in interface MetaCollection<S>
    
    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
```
public <T extends Meta<S>> void put(Class<T> cls,
                                    T meta)
```
    Description copied from interface: MetaCollection
    
    Puts a mapping of a meta class and the meta value into the collection, replacing the existing value if necessary
    
    Specified by:
    
    put in interface MetaCollection<S>
    
    Type Parameters:
    
    T - the meta value type
    
    Parameters:
    
    cls - the meta type
    
    meta - the meta value
  - putIfAbsent
```
public <T extends Meta<S>> boolean putIfAbsent(Class<T> cls,
                                               T meta)
```
    Description copied from interface: MetaCollection
    
    Appends the meta mapping only if it does not already exist as defined by MetaCollection.contains(Class). Otherwise has no effect.
    
    Specified by:
    
    putIfAbsent in interface MetaCollection<S>
    
    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
```
public <T extends Meta<S>> boolean contains(Class<T> cls)
```
    Description copied from interface: MetaCollection
    
    Obtains whether a mapping of the type provided exists within the collection
    
    Specified by:
    
    contains in interface MetaCollection<S>
    
    Type Parameters:
    
    T - the meta value type
    
    Parameters:
    
    cls - the meta type
    
    Returns:
    
    true if it exists, false if it doesn't
  - remove
```
public <T extends Meta<S>> T remove(Class<T> cls)
```
    Description copied from interface: MetaCollection
    
    Removes the meta tag from this collection
    
    Specified by:
    
    remove in interface MetaCollection<S>
    
    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
```
public void iterate(java.util.function.Consumer<Map.Entry<Class<? extends Meta<S>>,Meta<S>>> consumer)
```
    Description copied from interface: MetaCollection
    
    Iterates the collection
    
    Specified by:
    
    iterate in interface MetaCollection<S>
    
    Parameters:
    
    consumer - the iteration function
  - clear
```
public void clear()
```
    Description copied from interface: MetaCollection
    
    Clear the meta collection of meta values
    
    Specified by:
    
    clear in interface MetaCollection<S>

Class ImmutableMetaCollection<S>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyOf

get

put

putIfAbsent

put

putIfAbsent

contains

remove

iterate

clear