org.spongepowered.api.item.inventory.property

Class InventoryTitle

java.lang.Object

org.spongepowered.api.item.inventory.property.AbstractInventoryProperty<String,Text>

org.spongepowered.api.item.inventory.property.InventoryTitle

All Implemented Interfaces:

Comparable<Property<?,?>>, Property<String,Text>, InventoryProperty<String,Text>

public class InventoryTitle
extends AbstractInventoryProperty<String,Text>

The Title of an Inventory, viewable by players looking at the Inventory.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.Property

Property.Operator

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME

Fields inherited from class org.spongepowered.api.item.inventory.property.AbstractInventoryProperty

operator, value

Constructor Summary

Constructors

Constructor and Description
InventoryTitle(Text value) Creates a new InventoryTitle to be displayed on an Inventory.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property<?,?> other)
static InventoryTitle	of(Text value) Creates a new InventoryTitle with the provided Text.

Methods inherited from class org.spongepowered.api.item.inventory.property.AbstractInventoryProperty

equals, getDefaultKey, getDefaultKey, getDefaultOperator, getKey, getOperator, getValue, hashCode, hashCodeOf, matches

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

InventoryTitle

public InventoryTitle(Text value)

Creates a new InventoryTitle to be displayed on an Inventory.

Parameters:

value - The text value to display

Method Detail

compareTo

public int compareTo(Property<?,?> other)

of

public static InventoryTitle of(Text value)

Creates a new InventoryTitle with the provided Text.

Parameters:

value - The text value to display

Returns:

The new inventory title