Package com.prineside.luaj

Class LuaNumber

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaNumber

All Implemented Interfaces:

KryoSerializable

public final class LuaNumber
extends LuaValue
implements KryoSerializable

Nested Class Summary

Nested classes/interfaces inherited from class com.prineside.luaj.LuaValue

LuaValue.NillableSerializer, LuaValue.None

Nested classes/interfaces inherited from class com.prineside.luaj.Varargs

Varargs.ArrayVarargs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSTR_NAN
static final String	JSTR_NEGINF
static final String	JSTR_POSINF
static final LuaNumber	NAN
static final LuaNumber	NEGINF
static final LuaNumber	POSINF
static LuaValue	s_metatable	Shared static metatable for all number values represented in lua.

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CALL, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, IPAIRS, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, PAIRS, POW, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, ZERO

Method Summary

Modifier and Type	Method	Description
LuaValue	add(double lhs)	Add: Perform numeric add operation with another value of double type with metatag processing
LuaValue	add(LuaValue rhs)	Add: Perform numeric add operation with another value including metatag processing.
double	checkdouble()	Check that the value is numeric and return the value as a double, or throw LuaError if not numeric
int	checkint()	Check that the value is numeric, and convert and cast value to int, or throw LuaError if not numeric
String	checkjstring()	Convert this value to a Java String.
long	checklong()	Check that the value is numeric, and convert and cast value to long, or throw LuaError if not numeric
LuaNumber	checknumber()	Check that the value is numeric, and return as a LuaNumber if so, or throw LuaError
LuaNumber	checknumber(String errmsg)	Check that the value is numeric, and return as a LuaNumber if so, or throw LuaError
LuaString	checkstring()	Check that this is a lua string, or throw LuaError if it is not.
Buffer	concat(Buffer rhs)	Concatenate a Buffer onto this value and return the result using rules of lua string concatenation including metatag processing.
LuaValue	concat(LuaValue rhs)	Concatenate another value onto this value and return the result using rules of lua string concatenation including metatag processing.
LuaValue	concatTo(LuaNumber lhs)	Reverse-concatenation: concatenate this value onto another value known to be a LuaNumber and return the result using rules of lua string concatenation including metatag processing.
LuaValue	concatTo(LuaString lhs)	Reverse-concatenation: concatenate this value onto another value known to be a LuaString and return the result using rules of lua string concatenation including metatag processing.
static LuaValue	ddiv(double lhs, double rhs)	Divide two double numbers according to lua math, and return a LuaValue result.
static double	ddiv_d(double lhs, double rhs)	Divide two double numbers according to lua math, and return a double result.
LuaValue	div(double rhs)	Divide: Perform numeric divide operation by another value of double type without metatag processing
LuaValue	div(int rhs)	Divide: Perform numeric divide operation by another value of int type without metatag processing
LuaValue	div(LuaValue rhs)	Divide: Perform numeric divide operation by another value of unknown type, including metatag processing.
LuaValue	divInto(double lhs)	Reverse-divide: Perform numeric divide operation into another value with metatag processing
static LuaValue	dmod(double lhs, double rhs)	Take modulo double numbers according to lua math, and return a LuaValue result.
static double	dmod_d(double lhs, double rhs)	Take modulo for double numbers according to lua math, and return a double result.
LuaValue	eq(LuaValue val)	Equals: Perform equality comparison with another value including metatag processing using LuaValue.EQ.
boolean	eq_b(LuaValue val)	Equals: Perform equality comparison with another value including metatag processing using LuaValue.EQ, and return java boolean
boolean	equals(Object o)
LuaValue	getmetatable()	Get the metatable for this LuaValue
LuaValue	gt(double rhs)	Greater than: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.
LuaValue	gt(int rhs)	Greater than: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.
LuaValue	gt(LuaValue rhs)	Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.
boolean	gt_b(double rhs)	Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
boolean	gt_b(int rhs)	Greater than: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.
boolean	gt_b(LuaValue rhs)	Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
LuaValue	gteq(double rhs)	Greater than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.
LuaValue	gteq(int rhs)	Greater than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.
LuaValue	gteq(LuaValue rhs)	Greater than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.
boolean	gteq_b(double rhs)	Greater than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning java boolean.
boolean	gteq_b(int rhs)	Greater than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.
boolean	gteq_b(LuaValue rhs)	Greater than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
int	hashCode()
static int	hashCode(int x)
boolean	isint()	Check if this is a number and is representable by java int without rounding or truncation
boolean	isinttype()	Check if this is an int
boolean	islong()	Check if this is a number and is representable by java long without rounding or truncation
boolean	isnumber()	Check if this is a number
boolean	isstring()	Check if this is a string
boolean	isvalidkey()	Return true if this is a valid key in a table index operation.
LuaValue	lt(double rhs)	Less than: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.
LuaValue	lt(int rhs)	Less than: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.
LuaValue	lt(LuaValue rhs)	Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.
boolean	lt_b(double rhs)	Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
boolean	lt_b(int rhs)	Less than: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.
boolean	lt_b(LuaValue rhs)	Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
LuaValue	lteq(double rhs)	Less than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.
LuaValue	lteq(int rhs)	Less than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.
LuaValue	lteq(LuaValue rhs)	Less than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.
boolean	lteq_b(double rhs)	Less than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning java boolean.
boolean	lteq_b(int rhs)	Less than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.
boolean	lteq_b(LuaValue rhs)	Less than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.
LuaValue	mod(double rhs)	Modulo: Perform numeric modulo operation with another value of double type without metatag processing
LuaValue	mod(int rhs)	Modulo: Perform numeric modulo operation with another value of int type without metatag processing
LuaValue	mod(LuaValue rhs)	Modulo: Perform numeric modulo operation with another value of unknown type, including metatag processing.
LuaValue	modFrom(double lhs)	Reverse-modulo: Perform numeric modulo operation from another value with metatag processing
LuaValue	mul(double lhs)	Multiply: Perform numeric multiply operation with another value of double type with metatag processing
LuaValue	mul(int lhs)	Multiply: Perform numeric multiply operation with another value of int type with metatag processing
LuaValue	mul(LuaValue rhs)	Multiply: Perform numeric multiply operation with another value of unknown type, including metatag processing.
LuaValue	neg()	Unary minus: return negative value (-this) as defined by lua unary minus operator
double	optdouble(double defval)	Check that optional argument is a number or string convertible to number and return as double
int	optint(int defval)	Check that optional argument is a number or string convertible to number and return as int
String	optjstring(String defval)	Check that optional argument is a string or number and return as Java String
long	optlong(long defval)	Check that optional argument is a number or string convertible to number and return as long
LuaNumber	optnumber(LuaNumber defval)	Check that optional argument is a number or string convertible to number and return as LuaNumber
LuaString	optstring(LuaString defval)	Check that optional argument is a string or number and return as LuaString
int	originalHashCode()
LuaValue	pow(double rhs)	Raise to power: Raise this value to a power of double type with metatag processing
LuaValue	pow(int rhs)	Raise to power: Raise this value to a power of int type with metatag processing
LuaValue	pow(LuaValue rhs)	Raise to power: Raise this value to a power including metatag processing.
LuaValue	powWith(double lhs)	Reverse-raise to power: Raise another value of double type to this power with metatag processing
LuaValue	powWith(int lhs)	Reverse-raise to power: Raise another value of double type to this power with metatag processing
boolean	raweq(double val)	Equals: Perform direct equality comparison with a double value without metatag processing.
boolean	raweq(int val)	Equals: Perform direct equality comparison with a int value without metatag processing.
boolean	raweq(LuaValue val)	Equals: Perform direct equality comparison with another value without metatag processing.
void	read(Kryo kryo, Input input)
void	setDirectly(double v)
int	strcmp(LuaString rhs)	Perform string comparison with another value known to be a LuaString using string comparison based on byte values.
LuaString	strvalue()	Convert this value to a string if it is a LuaString or LuaNumber, or throw a LuaError if it is not
LuaValue	sub(double rhs)	Subtract: Perform numeric subtract operation with another value of double type with metatag processing
LuaValue	sub(int rhs)	Subtract: Perform numeric subtract operation with another value of int type with metatag processing
LuaValue	sub(LuaValue rhs)	Subtract: Perform numeric subtract operation with another value of unknown type, including metatag processing.
LuaValue	subFrom(double lhs)	Reverse-subtract: Perform numeric subtract operation from an int value with metatag processing
byte	tobyte()	Convert to byte if numeric, or 0 if not.
char	tochar()	Convert to char if numeric, or 0 if not.
double	todouble()	Convert to double if numeric, or 0 if not.
float	tofloat()	Convert to float if numeric, or 0 if not.
int	toint()	Convert to int if numeric, or 0 if not.
String	tojstring()	Convert to human readable String for any type.
long	tolong()	Convert to long if numeric, or 0 if not.
LuaValue	tonumber()	Conditionally convert to lua number without throwing errors.
short	toshort()	Convert to short if numeric, or 0 if not.
LuaValue	tostring()	Conditionally convert to lua string without throwing errors.
int	type()	Get the enumeration value for the type of this value.
String	typename()	Get the String name of the type of this value.
static LuaNumber	valueOf(double d)
static LuaNumber	valueOf(int d)
void	write(Kryo kryo, Output output)

Methods inherited from class com.prineside.luaj.LuaValue

add, and, arg, arg1, argerror, assert_, buffer, call, call, call, call, call, cBool, cDouble, cFloat, checkboolean, checkclosure, checkfunction, checkglobals, checknotnil, checktable, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, comparemt, concatmt, concatTo, cRegObject, eqmtcall, error, get, get, get, inext, initupvalue1, invoke, invoke, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isfunction, isnil, isRegObject, istable, isuserdata, isuserdata, len, length, listOf, listOf, load, metatag, method, method, method, method, method, method, narg, neq, neq_b, next, not, onInvoke, optboolean, optclosure, optfunction, opttable, optuserdata, optuserdata, optvalue, or, presize, raweq, raweq, rawget, rawget, rawget, rawlen, rawset, rawset, rawset, rawset, rawset, rawset, rawset, rawsetlist, set, set, set, set, set, set, set, setmetatable, strcmp, strongvalue, subargs, subFrom, tableOf, tableOf, tableOf, tableOf, tableOf, tableOf, tailcallOf, testfor_b, toboolean, toString, touserdata, touserdata, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf, varargsOf

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkuserdata, checkuserdata, checkvalue, dealias, eval, isfunction, isnil, isnoneornil, isnumber, isstring, istable, isTailcall, isuserdata, isvalue, optboolean, optclosure, optdouble, optfunction, optint, optjstring, optlong, optnumber, optstring, opttable, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

NAN

public static final LuaNumber NAN

POSINF

public static final LuaNumber POSINF

NEGINF

public static final LuaNumber NEGINF

JSTR_NAN

public static final String JSTR_NAN

See Also:

• Constant Field Values

JSTR_POSINF

public static final String JSTR_POSINF

See Also:

• Constant Field Values

JSTR_NEGINF

public static final String JSTR_NEGINF

See Also:

• Constant Field Values

s_metatable

public static LuaValue s_metatable

Shared static metatable for all number values represented in lua.

Method Details

write

public void write(Kryo kryo,
 Output output)

Specified by:

write in interface KryoSerializable

read

public void read(Kryo kryo,
 Input input)

Specified by:

read in interface KryoSerializable

hashCode

public static int hashCode(int x)

valueOf

public static LuaNumber valueOf(double d)

valueOf

public static LuaNumber valueOf(int d)

setDirectly

public void setDirectly(double v)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

originalHashCode

public int originalHashCode()

islong

public boolean islong()

Description copied from class: LuaValue

Check if this is a number and is representable by java long without rounding or truncation

Overrides:

islong in class LuaValue

Returns:

true if this is a number meaning derives from LuaNumber or derives from LuaString and is convertible to a number, and can be represented by long, otherwise false

See Also:

• LuaValue.tonumber()
• LuaValue.checklong()
• LuaValue.optlong(long)
• LuaValue.TNUMBER

isinttype

public boolean isinttype()

Description copied from class: LuaValue

Check if this is an int

No attempt to convert from string will be made by this call.

Overrides:

isinttype in class LuaValue

Returns:

true if this is a LuaInteger, otherwise false

See Also:

• LuaValue.isint()
• LuaValue.isnumber()
• LuaValue.tonumber()
• LuaValue.TNUMBER

isint

public boolean isint()

Description copied from class: LuaValue

Check if this is a number and is representable by java int without rounding or truncation

Overrides:

isint in class LuaValue

Returns:

true if this is a number meaning derives from LuaNumber or derives from LuaString and is convertible to a number, and can be represented by int, otherwise false

See Also:

• LuaValue.isinttype()
• LuaValue.islong()
• LuaValue.tonumber()
• LuaValue.checkint()
• LuaValue.optint(int)
• LuaValue.TNUMBER

tobyte

public byte tobyte()

Description copied from class: LuaValue

Convert to byte if numeric, or 0 if not.

Overrides:

tobyte in class LuaValue

Returns:

Value cast to byte if number or string convertible to number, otherwise 0

See Also:

• LuaValue.toint()
• LuaValue.todouble()
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

tochar

public char tochar()

Description copied from class: LuaValue

Convert to char if numeric, or 0 if not.

Overrides:

tochar in class LuaValue

Returns:

Value cast to char if number or string convertible to number, otherwise 0

See Also:

• LuaValue.toint()
• LuaValue.todouble()
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

todouble

public double todouble()

Description copied from class: LuaValue

Convert to double if numeric, or 0 if not.

Overrides:

todouble in class LuaValue

Returns:

Value cast to double if number or string convertible to number, otherwise 0

See Also:

• LuaValue.toint()
• LuaValue.tobyte()
• LuaValue.tochar()
• LuaValue.toshort()
• LuaValue.tolong()
• LuaValue.tofloat()
• LuaValue.optdouble(double)
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

tofloat

public float tofloat()

Description copied from class: LuaValue

Convert to float if numeric, or 0 if not.

Overrides:

tofloat in class LuaValue

Returns:

Value cast to float if number or string convertible to number, otherwise 0

See Also:

• LuaValue.toint()
• LuaValue.todouble()
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

toint

public int toint()

Description copied from class: LuaValue

Convert to int if numeric, or 0 if not.

Overrides:

toint in class LuaValue

Returns:

Value cast to int if number or string convertible to number, otherwise 0

See Also:

• LuaValue.tobyte()
• LuaValue.tochar()
• LuaValue.toshort()
• LuaValue.tolong()
• LuaValue.tofloat()
• LuaValue.todouble()
• LuaValue.optint(int)
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

tolong

public long tolong()

Description copied from class: LuaValue

Convert to long if numeric, or 0 if not.

Overrides:

tolong in class LuaValue

Returns:

Value cast to long if number or string convertible to number, otherwise 0

See Also:

• LuaValue.isint()
• LuaValue.isinttype()
• LuaValue.toint()
• LuaValue.todouble()
• LuaValue.optlong(long)
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

toshort

public short toshort()

Description copied from class: LuaValue

Convert to short if numeric, or 0 if not.

Overrides:

toshort in class LuaValue

Returns:

Value cast to short if number or string convertible to number, otherwise 0

See Also:

• LuaValue.toint()
• LuaValue.todouble()
• LuaValue.checknumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

optdouble

public double optdouble(double defval)

Description copied from class: LuaValue

Check that optional argument is a number or string convertible to number and return as double

Overrides:

optdouble in class LuaValue

Parameters:

defval - double to return if this is nil or none

Returns:

this cast to double if numeric, defval if nil or none, throws LuaError otherwise

See Also:

• LuaValue.optint(int)
• LuaValue.checkdouble()
• LuaValue.todouble()
• LuaValue.tonumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

optint

public int optint(int defval)

Description copied from class: LuaValue

Check that optional argument is a number or string convertible to number and return as int

Overrides:

optint in class LuaValue

Parameters:

defval - int to return if this is nil or none

Returns:

this cast to int if numeric, defval if nil or none, throws LuaError otherwise

See Also:

• LuaValue.optdouble(double)
• LuaValue.optlong(long)
• LuaValue.checkint()
• LuaValue.toint()
• LuaValue.tonumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

optlong

public long optlong(long defval)

Description copied from class: LuaValue

Check that optional argument is a number or string convertible to number and return as long

Overrides:

optlong in class LuaValue

Parameters:

defval - long to return if this is nil or none

Returns:

this cast to long if numeric, defval if nil or none, throws LuaError otherwise

See Also:

• LuaValue.optdouble(double)
• LuaValue.optint(int)
• LuaValue.checkint()
• LuaValue.toint()
• LuaValue.tonumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

neg

public LuaValue neg()

Description copied from class: LuaValue

Unary minus: return negative value (-this) as defined by lua unary minus operator

Overrides:

neg in class LuaValue

Returns:

boolean inverse as LuaBoolean if boolean or nil, numeric inverse as LuaNumber if numeric, or metatag processing result if LuaValue.UNM metatag is defined

equals

public boolean equals(Object o)

Overrides:

equals in class LuaValue

eq

public LuaValue eq(LuaValue val)

Description copied from class: LuaValue

Equals: Perform equality comparison with another value including metatag processing using LuaValue.EQ.

Overrides:

eq in class LuaValue

Parameters:

val - The value to compare with.

Returns:

LuaValue.TRUE if values are comparable and (this == rhs), LuaValue.FALSE if comparable but not equal, LuaValue if metatag processing occurs.

See Also:

• LuaValue.eq_b(LuaValue)
• LuaValue.raweq(LuaValue)
• LuaValue.neq(LuaValue)
• LuaValue.eqmtcall(LuaValue, LuaValue, LuaValue, LuaValue)
• LuaValue.EQ

eq_b

public boolean eq_b(LuaValue val)

Description copied from class: LuaValue

Equals: Perform equality comparison with another value including metatag processing using LuaValue.EQ, and return java boolean

Overrides:

eq_b in class LuaValue

Parameters:

val - The value to compare with.

Returns:

true if values are comparable and (this == rhs), false if comparable but not equal, result converted to java boolean if metatag processing occurs.

See Also:

• LuaValue.eq(LuaValue)
• LuaValue.raweq(LuaValue)
• LuaValue.neq_b(LuaValue)
• LuaValue.eqmtcall(LuaValue, LuaValue, LuaValue, LuaValue)
• LuaValue.EQ

raweq

public boolean raweq(LuaValue val)

Description copied from class: LuaValue

Equals: Perform direct equality comparison with another value without metatag processing.

Overrides:

raweq in class LuaValue

Parameters:

val - The value to compare with.

Returns:

true if (this == rhs), false otherwise

See Also:

• LuaValue.eq(LuaValue)
• LuaValue.raweq(LuaUserdata)
• LuaValue.raweq(LuaString)
• LuaValue.raweq(double)
• LuaValue.raweq(int)
• LuaValue.EQ

raweq

public boolean raweq(double val)

Description copied from class: LuaValue

Equals: Perform direct equality comparison with a double value without metatag processing.

Overrides:

raweq in class LuaValue

Parameters:

val - The double value to compare with.

Returns:

true if this is a LuaNumber whose value equals val, otherwise false

raweq

public boolean raweq(int val)

Description copied from class: LuaValue

Equals: Perform direct equality comparison with a int value without metatag processing.

Overrides:

raweq in class LuaValue

Parameters:

val - The double value to compare with.

Returns:

true if this is a LuaNumber whose value equals val, otherwise false

add

public LuaValue add(LuaValue rhs)

Description copied from class: LuaValue

Add: Perform numeric add operation with another value including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

add in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the add with

Returns:

value of (this + rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

add

public LuaValue add(double lhs)

Description copied from class: LuaValue

Add: Perform numeric add operation with another value of double type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

add in class LuaValue

Parameters:

lhs - The right-hand-side value to perform the add with

Returns:

value of (this + rhs) if this is numeric

See Also:

• LuaValue.add(LuaValue)

sub

public LuaValue sub(LuaValue rhs)

Description copied from class: LuaValue

Subtract: Perform numeric subtract operation with another value of unknown type, including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

sub in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the subtract with

Returns:

value of (this - rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

sub

public LuaValue sub(double rhs)

Description copied from class: LuaValue

Subtract: Perform numeric subtract operation with another value of double type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

sub in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the subtract with

Returns:

value of (this - rhs) if this is numeric

See Also:

• LuaValue.sub(LuaValue)

sub

public LuaValue sub(int rhs)

Description copied from class: LuaValue

Subtract: Perform numeric subtract operation with another value of int type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

sub in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the subtract with

Returns:

value of (this - rhs) if this is numeric

See Also:

• LuaValue.sub(LuaValue)

subFrom

public LuaValue subFrom(double lhs)

Description copied from class: LuaValue

Reverse-subtract: Perform numeric subtract operation from an int value with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

subFrom in class LuaValue

Parameters:

lhs - The left-hand-side value from which to perform the subtraction

Returns:

value of (lhs - this) if this is numeric

See Also:

• LuaValue.sub(LuaValue)
• LuaValue.sub(double)
• LuaValue.sub(int)

mul

public LuaValue mul(LuaValue rhs)

Description copied from class: LuaValue

Multiply: Perform numeric multiply operation with another value of unknown type, including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

mul in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the multiply with

Returns:

value of (this * rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

mul

public LuaValue mul(double lhs)

Description copied from class: LuaValue

Multiply: Perform numeric multiply operation with another value of double type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

mul in class LuaValue

Parameters:

lhs - The right-hand-side value to perform the multiply with

Returns:

value of (this * rhs) if this is numeric

mul

public LuaValue mul(int lhs)

Description copied from class: LuaValue

Multiply: Perform numeric multiply operation with another value of int type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

mul in class LuaValue

Parameters:

lhs - The right-hand-side value to perform the multiply with

Returns:

value of (this * rhs) if this is numeric

pow

public LuaValue pow(LuaValue rhs)

Description copied from class: LuaValue

Raise to power: Raise this value to a power including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

pow in class LuaValue

Parameters:

rhs - The power to raise this value to

Returns:

value of (this ^ rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

pow

public LuaValue pow(double rhs)

Description copied from class: LuaValue

Raise to power: Raise this value to a power of double type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

pow in class LuaValue

Parameters:

rhs - The power to raise this value to

Returns:

value of (this ^ rhs) if this is numeric

See Also:

• LuaValue.pow(LuaValue)

pow

public LuaValue pow(int rhs)

Description copied from class: LuaValue

Raise to power: Raise this value to a power of int type with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

pow in class LuaValue

Parameters:

rhs - The power to raise this value to

Returns:

value of (this ^ rhs) if this is numeric

See Also:

• LuaValue.pow(LuaValue)

powWith

public LuaValue powWith(double lhs)

Description copied from class: LuaValue

Reverse-raise to power: Raise another value of double type to this power with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

powWith in class LuaValue

Parameters:

lhs - The left-hand-side value which will be raised to this power

Returns:

value of (lhs ^ this) if this is numeric

See Also:

• LuaValue.pow(LuaValue)
• LuaValue.pow(double)
• LuaValue.pow(int)

powWith

public LuaValue powWith(int lhs)

Description copied from class: LuaValue

Reverse-raise to power: Raise another value of double type to this power with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

powWith in class LuaValue

Parameters:

lhs - The left-hand-side value which will be raised to this power

Returns:

value of (lhs ^ this) if this is numeric

See Also:

• LuaValue.pow(LuaValue)
• LuaValue.pow(double)
• LuaValue.pow(int)

div

public LuaValue div(LuaValue rhs)

Description copied from class: LuaValue

Divide: Perform numeric divide operation by another value of unknown type, including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

div in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the divulo with

Returns:

value of (this / rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

div

public LuaValue div(double rhs)

Description copied from class: LuaValue

Divide: Perform numeric divide operation by another value of double type without metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

For metatag processing LuaValue.div(LuaValue) must be used

Overrides:

div in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the divulo with

Returns:

value of (this / rhs) if this is numeric

See Also:

• LuaValue.div(LuaValue)

div

public LuaValue div(int rhs)

Description copied from class: LuaValue

Divide: Perform numeric divide operation by another value of int type without metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

For metatag processing LuaValue.div(LuaValue) must be used

Overrides:

div in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the divulo with

Returns:

value of (this / rhs) if this is numeric

See Also:

• LuaValue.div(LuaValue)

divInto

public LuaValue divInto(double lhs)

Description copied from class: LuaValue

Reverse-divide: Perform numeric divide operation into another value with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

divInto in class LuaValue

Parameters:

lhs - The left-hand-side value which will be divided by this

Returns:

value of (lhs / this) if this is numeric

See Also:

• LuaValue.div(LuaValue)
• LuaValue.div(double)
• LuaValue.div(int)

mod

public LuaValue mod(LuaValue rhs)

Description copied from class: LuaValue

Modulo: Perform numeric modulo operation with another value of unknown type, including metatag processing.

Each operand must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

mod in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the modulo with

Returns:

value of (this % rhs) if both are numeric, or LuaValue if metatag processing occurs

See Also:

• LuaValue.arithmt(LuaValue, LuaValue)

mod

public LuaValue mod(double rhs)

Description copied from class: LuaValue

Modulo: Perform numeric modulo operation with another value of double type without metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

For metatag processing LuaValue.mod(LuaValue) must be used

Overrides:

mod in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the modulo with

Returns:

value of (this % rhs) if this is numeric

See Also:

• LuaValue.mod(LuaValue)

mod

public LuaValue mod(int rhs)

Description copied from class: LuaValue

Modulo: Perform numeric modulo operation with another value of int type without metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

For metatag processing LuaValue.mod(LuaValue) must be used

Overrides:

mod in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the modulo with

Returns:

value of (this % rhs) if this is numeric

See Also:

• LuaValue.mod(LuaValue)

modFrom

public LuaValue modFrom(double lhs)

Description copied from class: LuaValue

Reverse-modulo: Perform numeric modulo operation from another value with metatag processing

this must derive from LuaNumber or derive from LuaString and be convertible to a number

Overrides:

modFrom in class LuaValue

Parameters:

lhs - The left-hand-side value which will be modulo'ed by this

Returns:

value of (lhs % this) if this is numeric

See Also:

• LuaValue.mod(LuaValue)
• LuaValue.mod(double)
• LuaValue.mod(int)

ddiv

public static LuaValue ddiv(double lhs,
 double rhs)

Divide two double numbers according to lua math, and return a LuaValue result.

Parameters:

lhs - Left-hand-side of the division.

rhs - Right-hand-side of the division.

Returns:

LuaValue for the result of the division, taking into account positive and negiative infinity, and Nan

See Also:

• ddiv_d(double, double)

ddiv_d

public static double ddiv_d(double lhs,
 double rhs)

Divide two double numbers according to lua math, and return a double result.

Parameters:

lhs - Left-hand-side of the division.

rhs - Right-hand-side of the division.

Returns:

Value of the division, taking into account positive and negative infinity, and Nan

See Also:

• ddiv(double, double)

dmod

public static LuaValue dmod(double lhs,
 double rhs)

Take modulo double numbers according to lua math, and return a LuaValue result.

Parameters:

lhs - Left-hand-side of the modulo.

rhs - Right-hand-side of the modulo.

Returns:

LuaValue for the result of the modulo, using lua's rules for modulo

See Also:

• dmod_d(double, double)

dmod_d

public static double dmod_d(double lhs,
 double rhs)

Take modulo for double numbers according to lua math, and return a double result.

Parameters:

lhs - Left-hand-side of the modulo.

rhs - Right-hand-side of the modulo.

Returns:

double value for the result of the modulo, using lua's rules for modulo

See Also:

• dmod(double, double)

lt

public LuaValue lt(LuaValue rhs)

Description copied from class: LuaValue

Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

lt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this < rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

lt

public LuaValue lt(double rhs)

Description copied from class: LuaValue

Less than: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

lt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this < rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(double)
• LuaValue.comparemt(LuaValue, LuaValue)

lt

public LuaValue lt(int rhs)

Description copied from class: LuaValue

Less than: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

lt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this < rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(int)
• LuaValue.comparemt(LuaValue, LuaValue)

lt_b

public boolean lt_b(LuaValue rhs)

Description copied from class: LuaValue

Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

lt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this < rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

lt_b

public boolean lt_b(int rhs)

Description copied from class: LuaValue

Less than: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

lt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this < rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(int)
• LuaValue.comparemt(LuaValue, LuaValue)

lt_b

public boolean lt_b(double rhs)

Description copied from class: LuaValue

Less than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

lt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this < rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq

public LuaValue lteq(LuaValue rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

lteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this <= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq

public LuaValue lteq(double rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

lteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this <= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(double)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq

public LuaValue lteq(int rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

lteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this <= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(int)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq_b

public boolean lteq_b(LuaValue rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

lteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this <= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq_b

public boolean lteq_b(int rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

lteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this <= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(int)
• LuaValue.comparemt(LuaValue, LuaValue)

lteq_b

public boolean lteq_b(double rhs)

Description copied from class: LuaValue

Less than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

lteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this <= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(double)
• LuaValue.comparemt(LuaValue, LuaValue)

gt

public LuaValue gt(LuaValue rhs)

Description copied from class: LuaValue

Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

gt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this > rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

gt

public LuaValue gt(double rhs)

Description copied from class: LuaValue

Greater than: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

gt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this > rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(double)
• LuaValue.comparemt(LuaValue, LuaValue)

gt

public LuaValue gt(int rhs)

Description copied from class: LuaValue

Greater than: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

gt in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this > rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(int)
• LuaValue.comparemt(LuaValue, LuaValue)

gt_b

public boolean gt_b(LuaValue rhs)

Description copied from class: LuaValue

Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

gt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this > rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

gt_b

public boolean gt_b(int rhs)

Description copied from class: LuaValue

Greater than: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

gt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this > rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(int)
• LuaValue.comparemt(LuaValue, LuaValue)

gt_b

public boolean gt_b(double rhs)

Description copied from class: LuaValue

Greater than: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

gt_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this > rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq

public LuaValue gteq(LuaValue rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning LuaValue.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

gteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this >= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq

public LuaValue gteq(double rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

gteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this >= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(double)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq

public LuaValue gteq(int rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning LuaValue.

To be comparable, this must derive from LuaNumber.

Overrides:

gteq in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

LuaValue.TRUE if (this >= rhs), LuaValue.FALSE if not, or LuaValue if metatag processing occurs

See Also:

• LuaValue.gteq_b(int)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq_b

public boolean gteq_b(LuaValue rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric or string comparison with another value of unknown type, including metatag processing, and returning java boolean.

To be comparable, both operands must derive from LuaString or both must derive from LuaNumber.

Overrides:

gteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this >= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(LuaValue)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq_b

public boolean gteq_b(int rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric comparison with another value of int type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

gteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this >= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(int)
• LuaValue.comparemt(LuaValue, LuaValue)

gteq_b

public boolean gteq_b(double rhs)

Description copied from class: LuaValue

Greater than or equals: Perform numeric comparison with another value of double type, including metatag processing, and returning java boolean.

To be comparable, this must derive from LuaNumber.

Overrides:

gteq_b in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

true if (this >= rhs), false if not, and boolean interpreation of result if metatag processing occurs.

See Also:

• LuaValue.gteq(double)
• LuaValue.comparemt(LuaValue, LuaValue)

strcmp

public int strcmp(LuaString rhs)

Description copied from class: LuaValue

Perform string comparison with another value known to be a LuaString using string comparison based on byte values.

Only strings can be compared, meaning each operand must derive from LuaString.

Overrides:

strcmp in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the comparison with

Returns:

int < 0 for (this < rhs), int > 0 for (this > rhs), or 0 when same string.

tojstring

public String tojstring()

Description copied from class: LuaValue

Convert to human readable String for any type.

Overrides:

tojstring in class LuaValue

Returns:

String for use by human readers based on type.

See Also:

• LuaValue.tostring()
• LuaValue.optjstring(String)
• LuaValue.checkjstring()
• LuaValue.isstring()
• LuaValue.TSTRING

strvalue

public LuaString strvalue()

Description copied from class: LuaValue

Convert this value to a string if it is a LuaString or LuaNumber, or throw a LuaError if it is not

Overrides:

strvalue in class LuaValue

Returns:

LuaString corresponding to the value if a string or number

optstring

public LuaString optstring(LuaString defval)

Description copied from class: LuaValue

Check that optional argument is a string or number and return as LuaString

Overrides:

optstring in class LuaValue

Parameters:

defval - LuaString to return if this is nil or none

Returns:

this converted to LuaString if a string or number, defval if nil or none, throws LuaError if some other type

See Also:

• LuaValue.tojstring()
• LuaValue.optjstring(String)
• LuaValue.checkstring()
• LuaValue.toString()
• LuaValue.TSTRING

tostring

public LuaValue tostring()

Description copied from class: LuaValue

Conditionally convert to lua string without throwing errors.

In lua all numbers are strings, so this function will return the LuaValue this if it is a string or number, and LuaValue.NIL for all other cases.

This allows values to be tested for their "string-ness" without the penalty of throwing exceptions.

Overrides:

tostring in class LuaValue

Returns:

this if it is a LuaString or LuaNumber, otherwise LuaValue.NIL

See Also:

• LuaValue.tonumber()
• LuaValue.tojstring()
• LuaValue.optstring(LuaString)
• LuaValue.checkstring()
• LuaValue.toString()

optjstring

public String optjstring(String defval)

Description copied from class: LuaValue

Check that optional argument is a string or number and return as Java String

Overrides:

optjstring in class LuaValue

Parameters:

defval - LuaString to return if this is nil or none

Returns:

this converted to String if a string or number, defval if nil or none, throws LuaError if some other type

See Also:

• LuaValue.tojstring()
• LuaValue.optstring(LuaString)
• LuaValue.checkjstring()
• LuaValue.toString()
• LuaValue.TSTRING

optnumber

public LuaNumber optnumber(LuaNumber defval)

Description copied from class: LuaValue

Check that optional argument is a number or string convertible to number and return as LuaNumber

Overrides:

optnumber in class LuaValue

Parameters:

defval - LuaNumber to return if this is nil or none

Returns:

this cast to LuaNumber if numeric, defval if nil or none, throws LuaError otherwise

See Also:

• LuaValue.optdouble(double)
• LuaValue.optlong(long)
• LuaValue.optint(int)
• LuaValue.checkint()
• LuaValue.toint()
• LuaValue.tonumber()
• LuaValue.isnumber()
• LuaValue.TNUMBER

isnumber

public boolean isnumber()

Description copied from class: LuaValue

Check if this is a number

Overrides:

isnumber in class LuaValue

Returns:

true if this is a number, meaning derives from LuaNumber or derives from LuaString and is convertible to a number, otherwise false

See Also:

• LuaValue.tonumber()
• LuaValue.checknumber()
• LuaValue.optnumber(LuaNumber)
• LuaValue.TNUMBER

isstring

public boolean isstring()

Description copied from class: LuaValue

Check if this is a string

Overrides:

isstring in class LuaValue

Returns:

true if this is a string, meaning derives from LuaString or LuaNumber, otherwise false

See Also:

• LuaValue.tostring()
• LuaValue.checkstring()
• LuaValue.optstring(LuaString)
• LuaValue.TSTRING

tonumber

public LuaValue tonumber()

Description copied from class: LuaValue

Conditionally convert to lua number without throwing errors.

In lua all numbers are strings, but not all strings are numbers. This function will return the LuaValue this if it is a number or a string convertible to a number, and LuaValue.NIL for all other cases.

This allows values to be tested for their "numeric-ness" without the penalty of throwing exceptions, nor the cost of converting the type and creating storage for it.

Overrides:

tonumber in class LuaValue

Returns:

this if it is a LuaNumber or LuaString that can be converted to a number, otherwise LuaValue.NIL

See Also:

• LuaValue.tostring()
• LuaValue.optnumber(LuaNumber)
• LuaValue.checknumber()
• LuaValue.toint()
• LuaValue.todouble()

checkint

public int checkint()

Description copied from class: LuaValue

Check that the value is numeric, and convert and cast value to int, or throw LuaError if not numeric

Values that are LuaNumber will be cast to int and may lose precision. Values that are LuaString that can be converted to a number will be converted, then cast to int, so may also lose precision.

Overrides:

checkint in class LuaValue

Returns:

value cast to a int if numeric

See Also:

• LuaValue.checklong()
• LuaValue.checkdouble()
• LuaValue.optint(int)
• LuaValue.TNUMBER

checklong

public long checklong()

Description copied from class: LuaValue

Check that the value is numeric, and convert and cast value to long, or throw LuaError if not numeric

Values that are LuaNumber will be cast to long and may lose precision. Values that are LuaString that can be converted to a number will be converted, then cast to long, so may also lose precision.

Overrides:

checklong in class LuaValue

Returns:

value cast to a long if numeric

See Also:

• LuaValue.checkint()
• LuaValue.checkdouble()
• LuaValue.optlong(long)
• LuaValue.TNUMBER

checknumber

public LuaNumber checknumber()

Description copied from class: LuaValue

Check that the value is numeric, and return as a LuaNumber if so, or throw LuaError

Values that are LuaString that can be converted to a number will be converted and returned.

Overrides:

checknumber in class LuaValue

Returns:

value as a LuaNumber if numeric

See Also:

• LuaValue.checkint()
• LuaValue.checkdouble()
• LuaValue.checklong()
• LuaValue.optnumber(LuaNumber)
• LuaValue.TNUMBER

checkdouble

public double checkdouble()

Description copied from class: LuaValue

Check that the value is numeric and return the value as a double, or throw LuaError if not numeric

Values that are LuaNumber and values that are LuaString that can be converted to a number will be converted to double.

Overrides:

checkdouble in class LuaValue

Returns:

value cast to a double if numeric

See Also:

• LuaValue.checkint()
• LuaValue.checklong()
• LuaValue.optdouble(double)
• LuaValue.TNUMBER

checkjstring

public String checkjstring()

Description copied from class: LuaValue

Convert this value to a Java String.

The string representations here will roughly match what is produced by the C lua distribution, however hash codes have no relationship, and there may be differences in number formatting.

Overrides:

checkjstring in class LuaValue

Returns:

String representation of the value

See Also:

• LuaValue.checkstring()
• LuaValue.optjstring(String)
• LuaValue.tojstring()
• LuaValue.isstring()
• LuaValue.TSTRING

checkstring

public LuaString checkstring()

Description copied from class: LuaValue

Check that this is a lua string, or throw LuaError if it is not.

In lua all numbers are strings, so this will succeed for anything that derives from LuaString or LuaNumber. Numbers will be converted to LuaString.

Overrides:

checkstring in class LuaValue

Returns:

LuaString representation of the value if it is a LuaString or LuaNumber

See Also:

• LuaValue.checkjstring()
• LuaValue.optstring(LuaString)
• LuaValue.tostring()
• LuaValue.isstring()
• LuaValue.TSTRING

isvalidkey

public boolean isvalidkey()

Description copied from class: LuaValue

Return true if this is a valid key in a table index operation.

Overrides:

isvalidkey in class LuaValue

Returns:

true if valid as a table key, otherwise false

See Also:

• LuaValue.isnil()
• LuaValue.isinttype()

type

public int type()

Description copied from class: LuaValue

Get the enumeration value for the type of this value.

Specified by:

type in class LuaValue

Returns:

value for this type, one of LuaValue.TNIL, LuaValue.TBOOLEAN, LuaValue.TNUMBER, LuaValue.TSTRING, LuaValue.TTABLE, LuaValue.TFUNCTION, LuaValue.TUSERDATA, LuaValue.TTHREAD

See Also:

• LuaValue.typename()

typename

public String typename()

Description copied from class: LuaValue

Get the String name of the type of this value.

Specified by:

typename in class LuaValue

Returns:

name from type name list LuaValue.TYPE_NAMES corresponding to the type of this value: "nil", "boolean", "number", "string", "table", "function", "userdata", "thread"

See Also:

• LuaValue.type()

checknumber

public LuaNumber checknumber(String errmsg)

Description copied from class: LuaValue

Check that the value is numeric, and return as a LuaNumber if so, or throw LuaError

Values that are LuaString that can be converted to a number will be converted and returned.

Overrides:

checknumber in class LuaValue

Parameters:

errmsg - String message to supply if conversion fails

Returns:

value as a LuaNumber if numeric

See Also:

• LuaValue.checkint()
• LuaValue.checkdouble()
• LuaValue.checklong()
• LuaValue.optnumber(LuaNumber)
• LuaValue.TNUMBER

getmetatable

public LuaValue getmetatable()

Description copied from class: LuaValue

Get the metatable for this LuaValue

For LuaTable and LuaUserdata instances, the metatable returned is this instance metatable. For all other types, the class metatable value will be returned.

Overrides:

getmetatable in class LuaValue

Returns:

metatable, or null if it there is none

concat

public LuaValue concat(LuaValue rhs)

Description copied from class: LuaValue

Concatenate another value onto this value and return the result using rules of lua string concatenation including metatag processing.

Only strings and numbers as represented can be concatenated, meaning each operand must derive from LuaString or LuaNumber.

Overrides:

concat in class LuaValue

Parameters:

rhs - The right-hand-side value to perform the operation with

Returns:

LuaValue resulting from concatenation of (this .. rhs)

concat

public Buffer concat(Buffer rhs)

Description copied from class: LuaValue

Concatenate a Buffer onto this value and return the result using rules of lua string concatenation including metatag processing.

Only strings and numbers as represented can be concatenated, meaning each operand must derive from LuaString or LuaNumber.

Overrides:

concat in class LuaValue

Parameters:

rhs - The right-hand-side Buffer to perform the operation with

Returns:

LuaString resulting from concatenation of (this .. rhs)

concatTo

public LuaValue concatTo(LuaNumber lhs)

Description copied from class: LuaValue

Reverse-concatenation: concatenate this value onto another value known to be a LuaNumber and return the result using rules of lua string concatenation including metatag processing.

Only strings and numbers as represented can be concatenated, meaning each operand must derive from LuaString or LuaNumber.

Overrides:

concatTo in class LuaValue

Parameters:

lhs - The left-hand-side value onto which this will be concatenated

Returns:

LuaValue resulting from concatenation of (lhs .. this)

See Also:

• LuaValue.concat(LuaValue)

concatTo

public LuaValue concatTo(LuaString lhs)

Description copied from class: LuaValue

Reverse-concatenation: concatenate this value onto another value known to be a LuaString and return the result using rules of lua string concatenation including metatag processing.

Only strings and numbers as represented can be concatenated, meaning each operand must derive from LuaString or LuaNumber.

Overrides:

concatTo in class LuaValue

Parameters:

lhs - The left-hand-side value onto which this will be concatenated

Returns:

LuaValue resulting from concatenation of (lhs .. this)

See Also:

• LuaValue.concat(LuaValue)