org.spongepowered.api.world.schematic

Interface Palette<T extends CatalogType>

Type Parameters:

T - The type this palette will maintain

All Known Subinterfaces:

BlockPalette

public interface Palette<T extends CatalogType>

Represents a mapping for types to a local identifier. Can be used for mapping CatalogTypes to int id's for storage purposes, or for converting stored information to a representable format back into CatalogTypes.

Method Summary

Modifier and Type	Method and Description
Optional<T>	get(int id) Gets the type represented by the given identifier from the mapping.
Optional<Integer>	get(T type) Gets the identifier for the given type T if it exists within the mapping.
Collection<T>	getEntries() Gets all type Ts contained in this palette.
int	getHighestId() Gets the highest identifier in this palette.
int	getOrAssign(T type) Gets the identifier for the given type T from the mapping.
PaletteType<T>	getType() Gets the type of this palette.
boolean	remove(T type) Removes the given type T from the mapping.

Method Detail

getType

PaletteType<T> getType()

Gets the type of this palette.

Returns:

The palette type

getHighestId

int getHighestId()

Gets the highest identifier in this palette.

Returns:

The highest id

get

Optional<T> get(int id)

Gets the type represented by the given identifier from the mapping.

Parameters:

id - The identifier

Returns:

The type, if found

get

Optional<Integer> get(T type)

Gets the identifier for the given type T if it exists within the mapping.

Parameters:

type - The type

Returns:

The identifier, if found

getOrAssign

int getOrAssign(T type)

Gets the identifier for the given type T from the mapping. If the type T is not yet registered in the mapping then it is registered and given the next available identifier.

Parameters:

type - The type

Returns:

The identifier

remove

boolean remove(T type)

Removes the given type T from the mapping.

Note that if this palette is considered a global palette, removal is not supported.

Parameters:

type - The type to remove

Returns:

If the type existed in the mapping

getEntries

Collection<T> getEntries()

Gets all type Ts contained in this palette.

Returns:

All contained types