Package me.remigio07.chatplugin.api.common.util

Class ValueContainer<T extends Number>

java.lang.Object

me.remigio07.chatplugin.api.common.util.ValueContainer<T>

Type Parameters:

T - Value type

public class ValueContainer<T extends Number>
extends Object

Util class used to contain a value that can be either a fixed number or a placeholder's variable value.

Constructor Summary

Constructors

Constructor	Description
ValueContainer(Object value)	Constructs a value container using given object, which can either extend Number or be a String placeholder.

Method Summary

Modifier and Type	Method	Description
byte	byteValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing a byte value.
double	doubleValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing a double value.
float	floatValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing a float value.
int	intValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing an integer value.
long	longValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing a long value.
String	placeholder()	Gets this container's placeholder.
short	shortValue(List<PlaceholderType> placeholderTypes, ChatPluginServerPlayer player)	Translates value() or placeholder() into a string containing a short value.
T	value()	Gets this container's fixed value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ValueContainer

public ValueContainer(Object value)

Constructs a value container using given object, which can either extend Number or be a String placeholder.

Parameters:

value - Object value

Method Details

placeholder

public String placeholder()

Gets this container's placeholder.

Will return null if a fixed value was specified at construction.

Returns:

Container's placeholder

value

public T value()

Gets this container's fixed value.

Will return null if a placeholder was specified at construction.

Returns:

Container's fixed value

byteValue

public byte byteValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
               throws NumberFormatException

Translates value() or placeholder() into a string containing a byte value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid

shortValue

public short shortValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
                 throws NumberFormatException

Translates value() or placeholder() into a string containing a short value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid

intValue

public int intValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
             throws NumberFormatException

Translates value() or placeholder() into a string containing an integer value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid

longValue

public long longValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
               throws NumberFormatException

Translates value() or placeholder() into a string containing a long value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid

floatValue

public float floatValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
                 throws NumberFormatException

Translates value() or placeholder() into a string containing a float value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid

doubleValue

public double doubleValue(List<PlaceholderType> placeholderTypes,
 ChatPluginServerPlayer player)
                   throws NumberFormatException

Translates value() or placeholder() into a string containing a double value.

Parameters:

placeholderTypes - Placeholder types containing placeholder()

player - Player whose placeholders need to be translated

Returns:

Translated value or placeholder

Throws:

NumberFormatException - If the placeholder is invalid