org.spongepowered.api.item.inventory

Interface InventoryArchetype

All Superinterfaces:

CatalogType

@CatalogedBy(value=InventoryArchetypes.class)
public interface InventoryArchetype
extends CatalogType

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InventoryArchetype.Builder A Builder for InventoryArchetypes.

Method Summary

Modifier and Type	Method and Description
static InventoryArchetype.Builder	builder() Creates a new InventoryArchetype.Builder to build an InventoryArchetype.
List<InventoryArchetype>	getChildArchetypes() Gets all child InventoryArchetypes.
Map<String,InventoryProperty<String,?>>	getProperties() Returns all properties defined on this Archetype.
default <T extends InventoryProperty<String,?>> Optional<T>	getProperty(Class<T> type) Returns the property with the Properties default key.
<T extends InventoryProperty<String,?>> Optional<T>	getProperty(Class<T> type, String key) Returns the property
Optional<InventoryProperty<String,?>>	getProperty(String key) Returns the Property with given key.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static InventoryArchetype.Builder builder()

Creates a new InventoryArchetype.Builder to build an InventoryArchetype.

Returns:

The builder

getChildArchetypes

List<InventoryArchetype> getChildArchetypes()

Gets all child InventoryArchetypes.

Returns:

The child Archetypes

getProperties

Map<String,InventoryProperty<String,?>> getProperties()

Returns all properties defined on this Archetype.

Returns:

The properties

getProperty

Optional<InventoryProperty<String,?>> getProperty(String key)

Returns the Property with given key.

Parameters:

key - The key

Returns:

The matching Property or Optional.empty() if not found

getProperty

default <T extends InventoryProperty<String,?>> Optional<T> getProperty(Class<T> type)

Returns the property with the Properties default key.

Type Parameters:

T - Expected Type of InventoryProperty

Parameters:

type - The type of Property to query for

Returns:

The matching Property or Optional.empty() if not found

getProperty

<T extends InventoryProperty<String,?>> Optional<T> getProperty(Class<T> type,
                                                                String key)

Returns the property

Type Parameters:

T - Expected Type of InventoryProperty

Parameters:

type - The type of Property to query for

key - The Property key to search for

Returns:

The matching Property or Optional.empty() if not found