org.luaj.vm2
Class Varargs

java.lang.Object
  org.luaj.vm2.Varargs

Direct Known Subclasses:

LuaValue, TailcallVarargs

public abstract class Varargs
extends java.lang.Object

Class to encapsulate varargs values.

Constructor Summary

Varargs()

Method Summary

abstract LuaValue	arg(int i) Get the n-th argument value (1-based)
abstract LuaValue	arg1() Get the first argument
void	argcheck(boolean test, int i, java.lang.String msg)
boolean	checkboolean(int i)
LuaClosure	checkclosure(int i)
double	checkdouble(int i)
LuaValue	checkfunction(int i)
int	checkint(int i)
LuaInteger	checkinteger(int i)
java.lang.String	checkjstring(int i)
long	checklong(int i)
LuaValue	checknotnil(int i)
LuaNumber	checknumber(int i)
LuaString	checkstring(int i)
java.lang.String	checkString(int i) Deprecated. - use checkjstring() instead
LuaTable	checktable(int i)
LuaThread	checkthread(int i)
java.lang.Object	checkuserdata(int i)
java.lang.Object	checkuserdata(int i, java.lang.Class c)
LuaValue	checkvalue(int i)
Varargs	eval() Evaluate any pending tail call and return result
boolean	isfunction(int i)
boolean	isnil(int i)
boolean	isnoneornil(int i)
boolean	isnumber(int i)
boolean	isstring(int i)
boolean	istable(int i)
boolean	isTailcall() Return true if this is a TailcallVarargs
boolean	isthread(int i)
boolean	isuserdata(int i)
boolean	isvalue(int i)
abstract int	narg() Get the number of arguments, or 0 if there are none.
boolean	optboolean(int i, boolean defval)
LuaClosure	optclosure(int i, LuaClosure defval)
double	optdouble(int i, double defval)
LuaFunction	optfunction(int i, LuaFunction defval)
int	optint(int i, int defval)
LuaInteger	optinteger(int i, LuaInteger defval)
java.lang.String	optjstring(int i, java.lang.String defval)
long	optlong(int i, long defval)
LuaNumber	optnumber(int i, LuaNumber defval)
LuaString	optstring(int i, LuaString defval)
java.lang.String	optString(int i, java.lang.String defval) Deprecated. - use optjstring() instead
LuaTable	opttable(int i, LuaTable defval)
LuaThread	optthread(int i, LuaThread defval)
java.lang.Object	optuserdata(int i, java.lang.Class c, java.lang.Object defval)
java.lang.Object	optuserdata(int i, java.lang.Object defval)
LuaValue	optvalue(int i, LuaValue defval)
Varargs	subargs(int start)
boolean	toboolean(int i)
byte	tobyte(int i)
char	tochar(int i)
double	todouble(int i)
float	tofloat(int i)
int	toint(int i)
java.lang.String	tojstring()
java.lang.String	tojstring(int i)
long	tolong(int i)
short	toshort(int i)
java.lang.String	toString()
java.lang.Object	touserdata(int i)
java.lang.Object	touserdata(int i, java.lang.Class c)
int	type(int i)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Varargs

public Varargs()

Method Detail

arg

public abstract LuaValue arg(int i)

Get the n-th argument value (1-based)

Parameters:

i - 1 for the first argument, 2 for the second, etc.

Returns:

Value at position i, or Value.NIL if there is none.

narg

public abstract int narg()

Get the number of arguments, or 0 if there are none.

Returns:

number of arguments.

arg1

public abstract LuaValue arg1()

Get the first argument

Returns:

Value

eval

public Varargs eval()

Evaluate any pending tail call and return result

Returns:

the evaluated tail call result

isTailcall

public boolean isTailcall()

Return true if this is a TailcallVarargs

Returns:

true if a tail call, false otherwise

type

public int type(int i)

isnil

public boolean isnil(int i)

isfunction

public boolean isfunction(int i)

isnumber

public boolean isnumber(int i)

isstring

public boolean isstring(int i)

istable

public boolean istable(int i)

isthread

public boolean isthread(int i)

isuserdata

public boolean isuserdata(int i)

isvalue

public boolean isvalue(int i)

optboolean

public boolean optboolean(int i,
                          boolean defval)

optclosure

public LuaClosure optclosure(int i,
                             LuaClosure defval)

optdouble

public double optdouble(int i,
                        double defval)

optfunction

public LuaFunction optfunction(int i,
                               LuaFunction defval)

optint

public int optint(int i,
                  int defval)

optinteger

public LuaInteger optinteger(int i,
                             LuaInteger defval)

optlong

public long optlong(int i,
                    long defval)

optnumber

public LuaNumber optnumber(int i,
                           LuaNumber defval)

optjstring

public java.lang.String optjstring(int i,
                                   java.lang.String defval)

optstring

public LuaString optstring(int i,
                           LuaString defval)

opttable

public LuaTable opttable(int i,
                         LuaTable defval)

optthread

public LuaThread optthread(int i,
                           LuaThread defval)

optuserdata

public java.lang.Object optuserdata(int i,
                                    java.lang.Object defval)

optuserdata

public java.lang.Object optuserdata(int i,
                                    java.lang.Class c,
                                    java.lang.Object defval)

optvalue

public LuaValue optvalue(int i,
                         LuaValue defval)

optString

public java.lang.String optString(int i,
                                  java.lang.String defval)

Deprecated. - use optjstring() instead

checkboolean

public boolean checkboolean(int i)

checkclosure

public LuaClosure checkclosure(int i)

checkdouble

public double checkdouble(int i)

checkfunction

public LuaValue checkfunction(int i)

checkint

public int checkint(int i)

checkinteger

public LuaInteger checkinteger(int i)

checklong

public long checklong(int i)

checknumber

public LuaNumber checknumber(int i)

checkjstring

public java.lang.String checkjstring(int i)

checkstring

public LuaString checkstring(int i)

checktable

public LuaTable checktable(int i)

checkthread

public LuaThread checkthread(int i)

checkuserdata

public java.lang.Object checkuserdata(int i)

checkuserdata

public java.lang.Object checkuserdata(int i,
                                      java.lang.Class c)

checkvalue

public LuaValue checkvalue(int i)

checknotnil

public LuaValue checknotnil(int i)

checkString

public java.lang.String checkString(int i)

Deprecated. - use checkjstring() instead

argcheck

public void argcheck(boolean test,
                     int i,
                     java.lang.String msg)

isnoneornil

public boolean isnoneornil(int i)

toboolean

public boolean toboolean(int i)

tobyte

public byte tobyte(int i)

tochar

public char tochar(int i)

todouble

public double todouble(int i)

tofloat

public float tofloat(int i)

toint

public int toint(int i)

tolong

public long tolong(int i)

tojstring

public java.lang.String tojstring(int i)

toshort

public short toshort(int i)

touserdata

public java.lang.Object touserdata(int i)

touserdata

public java.lang.Object touserdata(int i,
                                   java.lang.Class c)

tojstring

public java.lang.String tojstring()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

subargs

public Varargs subargs(int start)