ru.abstractmenus.api.variables

Interface Var

public interface Var

Variable data. Variables are immutable. If you need to change and save it again, you need to clone it first.

Method Summary

Modifier and Type	Method and Description
boolean	boolValue() Parse value as boolean Raw value will be parsed as true, if it equals to "true" or "1"
double	doubleValue() Parse value as double
long	expiry() Expiry time of this variable, if specified.
float	floatValue() Parse value as float
boolean	hasExpiry() Has this variable expiry time
int	intValue() Parse value as integer
boolean	isExpired() Is this variable expired
long	longValue() Parse value as long
java.lang.String	name() Name of this variable
VarBuilder	toBuilder() Convert this value to builder with current values
java.lang.String	value() Raw value of variable.

Method Detail

name

java.lang.String name()

Name of this variable

Returns:

Name of this variable

value

java.lang.String value()

Raw value of variable. Values always stored in string format

Returns:

Raw value of this variable

expiry

long expiry()

Expiry time of this variable, if specified. This time can be compared, using System.currentTimeMillis() If variable has no expiry time, it will return 0

Returns:

Expiry time

hasExpiry

boolean hasExpiry()

Has this variable expiry time

Returns:

Try if variable has expiry time or false otherwise

isExpired

boolean isExpired()

Is this variable expired

Returns:

true if variable expired, false otherwise

boolValue

boolean boolValue()

Parse value as boolean Raw value will be parsed as true, if it equals to "true" or "1"

Returns:

Boolean value, parsed from raw string

intValue

int intValue()
      throws java.lang.NumberFormatException

Parse value as integer

Returns:

Integer value, parsed from raw string

Throws:

java.lang.NumberFormatException - if raw value cannot be parsed as integer

longValue

long longValue()
        throws java.lang.NumberFormatException

Parse value as long

Returns:

Long value, parsed from raw string

Throws:

java.lang.NumberFormatException - if raw value cannot be parsed as long

floatValue

float floatValue()
          throws java.lang.NumberFormatException

Parse value as float

Returns:

Float value, parsed from raw string

Throws:

java.lang.NumberFormatException - if raw value cannot be parsed as float

doubleValue

double doubleValue()
            throws java.lang.NumberFormatException

Parse value as double

Returns:

Double value, parsed from raw string

Throws:

java.lang.NumberFormatException - if raw value cannot be parsed as double

toBuilder

VarBuilder toBuilder()

Convert this value to builder with current values

Returns:

New builder with current var values