Package com.palmergames.bukkit.towny.object.metadata

Class StringDataField

java.lang.Object

com.palmergames.bukkit.towny.object.metadata.CustomDataField<String>

com.palmergames.bukkit.towny.object.metadata.StringDataField

All Implemented Interfaces:

Cloneable

public class StringDataField
extends CustomDataField<String>

Field Summary

Fields inherited from class com.palmergames.bukkit.towny.object.metadata.CustomDataField

label

Constructor Summary

Constructors

Constructor	Description
StringDataField(String key)
StringDataField(String key, String value)
StringDataField(String key, String value, String label)

Method Summary

Modifier and Type	Method	Description
CustomDataField<String>	clone()
String	displayFormattedValue()	Formats and colors the value of the custom data field object.
String	getTypeID()	Gets the type id for the given CustomDataField class.
void	setValueFromString(String strValue)	Sets the value based on the given input.
static String	typeID()

Methods inherited from class com.palmergames.bukkit.towny.object.metadata.CustomDataField

canParseFromString, equals, formatValueAsComp, getKey, getLabel, getLabelAsComp, getValue, hashCode, hasLabel, isValidType, serializeValueToString, setLabel, setValue, shouldDisplayInStatus, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StringDataField

public StringDataField(String key)

StringDataField

public StringDataField(String key,
 String value,
 String label)

StringDataField

public StringDataField(String key,
 String value)

Method Details

getTypeID

public String getTypeID()

Description copied from class: CustomDataField

Gets the type id for the given CustomDataField class. This value is attached to the class, and not a specific instance. Used for serialization purposes.

Specified by:

getTypeID in class CustomDataField<String>

Returns:

type id of the given CustomDataField class.

typeID

public static String typeID()

setValueFromString

public void setValueFromString(String strValue)

Description copied from class: CustomDataField

Sets the value based on the given input. Used when admins want to edit metadata in-game.

Specified by:

setValueFromString in class CustomDataField<String>

Parameters:

strValue - input.

displayFormattedValue

public String displayFormattedValue()

Description copied from class: CustomDataField

Formats and colors the value of the custom data field object.

Specified by:

displayFormattedValue in class CustomDataField<String>

Returns:

the formatted value of this data field.

clone

public CustomDataField<String> clone()

Specified by:

clone in class CustomDataField<String>