net.tridentsdk.meta.component

Interface MetaOwner<T>

All Known Subinterfaces:

Block, BlockMetaOwner<T>

All Known Implementing Classes:

AbstractBlockMetaOwner, OwnedTridentBlock, TridentBlock

@ThreadSafe
public interface MetaOwner<T>

Represents an object which carries metadata

Since:

0.4-alpha

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
<M extends T> boolean	applyMeta(boolean replace, M... meta) Commits the changes from the meta value to the block
<M extends T> void	applyMeta(M... meta) Applies the specified metas to the owner, replacing the previous value if present
void	clearMeta() Removes all meta values and sets the block meta to (byte) 0
<M extends T> M	newMetaIfNull(Class<M> cls) Creates a new metadata value for the type specified if this block supports it, and it is not already created in the block
<M extends T> M	obtainMeta(Class<M> cls) Obtains the meta tag from the class type
<M extends MetaOwner> MetaCollection<M>	ownedMeta() Gets all of the metadata values currently owned by this meta owner

Method Detail

obtainMeta

<M extends T> M obtainMeta(Class<M> cls)

Obtains the meta tag from the class type

Type Parameters:

M - the meta type

Parameters:

cls - the class type of the meta value

Returns:

the meta value, or null if the meta is not owned

newMetaIfNull

<M extends T> M newMetaIfNull(Class<M> cls)

Creates a new metadata value for the type specified if this block supports it, and it is not already created in the block

Type Parameters:

M - the meta

Parameters:

cls - the meta type

Returns:

the meta value, or null if it could not be made

ownedMeta

<M extends MetaOwner> MetaCollection<M> ownedMeta()

Gets all of the metadata values currently owned by this meta owner

Returns:

the currently owned collection of meta values

applyMeta

<M extends T> void applyMeta(M... meta)

Applies the specified metas to the owner, replacing the previous value if present

Type Parameters:

M - the meta type

Parameters:

meta - the metas to apply

applyMeta

<M extends T> boolean applyMeta(boolean replace,
                                M... meta)

Commits the changes from the meta value to the block

Type Parameters:

M - the meta type

Parameters:

meta - the metadata

replace - true to apply meta anyways if the data mapping already exists

Returns:

true if the all of the meta changes took effect

clearMeta

void clearMeta()

Removes all meta values and sets the block meta to (byte) 0