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

Class ByteDataField

java.lang.Object

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

com.palmergames.bukkit.towny.object.metadata.ByteDataField

All Implemented Interfaces:

Cloneable

public class ByteDataField
extends CustomDataField<Byte>

Field Summary

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

label

Constructor Summary

Constructors

Constructor	Description
ByteDataField(String key)
ByteDataField(String key, byte value)
ByteDataField(String key, byte value, String label)

Method Summary

Modifier and Type	Method	Description
boolean	canParseFromString(String str)	Determines whether the given input can be parsed to the appropriate value.
@NotNull CustomDataField<Byte>	clone()
String	displayFormattedValue()	Formats and colors the value of the custom data field object.
@NotNull 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

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

ByteDataField

public ByteDataField(String key)

ByteDataField

public ByteDataField(String key,
 byte value,
 String label)

ByteDataField

public ByteDataField(String key,
 byte value)

Method Details

getTypeID

@NotNull
public @NotNull 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<Byte>

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<Byte>

Parameters:

strValue - input.

canParseFromString

public boolean canParseFromString(String str)

Description copied from class: CustomDataField

Determines whether the given input can be parsed to the appropriate value. Used to parse admin input for in-game metadata editing.

Overrides:

canParseFromString in class CustomDataField<Byte>

Parameters:

str - admin input

Returns:

whether the string can be parsed or not

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<Byte>

Returns:

the formatted value of this data field.

clone

@NotNull
public @NotNull CustomDataField<Byte> clone()

Specified by:

clone in class CustomDataField<Byte>