LuaState

java.lang.Object
- com.naef.jnlua.LuaState

public class LuaState
extends Object

JNLua core class representing a Lua instance.

The class performs extensive checking on all arguments and its state. Specifically, the following exceptions are thrown under the indicated conditions:

Exception	When
`NullPointerException`	if an argument is `null` and the API does not explicitly specify that the argument may be `null`
`IllegalStateException`	if the Lua state is closed and the API does not explicitly specify that the method may be invoked on a closed Lua state
`IllegalArgumentException`	if a stack index refers to an undefined stack location and the API does not explicitly specify that the stack index may be undefined
`IllegalArgumentException`	if a stack index refers to an stack location with value type that is different from the value type explicitly specified in the API
`IllegalArgumentException`	if a count is negative or out of range and the API does not explicitly specify that the count may be negative or out of range
`LuaRuntimeException`	if a Lua runtime error occurs
`LuaSyntaxException`	if a the syntax of a Lua chunk is incorrect
`LuaMemoryAllocationException`	if the Lua memory allocator runs out of memory or if a JNI allocation fails

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LuaState.GcAction
Represents a Lua garbage collector action.

static class LuaState.Library
Represents a Lua library.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LuaState.GcAction` Represents a Lua garbage collector action.
`static class`	`LuaState.Library` Represents a Lua library.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ENVIRONINDEX` Environment pseudo-index.
`static int`	`GLOBALSINDEX` Globals pseudo-index.
`static String`	`LUA_VERSION` The Lua version.
`static int`	`MULTRET` Multiple returns pseudo return value count.
`static int`	`REGISTRYINDEX` Registry pseudo-index.
`static String`	`VERSION` The JNLua version.
`static int`	`YIELD` Status indicating that a thread is suspended.

Constructor Summary

Constructors
Constructor and Description

LuaState()
Creates a new instance.

LuaState(long luaState)
Creates a new instance.

Constructors
Constructor and Description
`LuaState()` Creates a new instance.
`LuaState(long luaState)` Creates a new instance.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`call(int argCount, int returnCount)` Calls a Lua function.
`void`	`checkArg(int index, boolean condition, String msg)` Checks if a condition is true for the specified function argument.
`boolean`	`checkBoolean(int index)` Checks if the value of the specified function argument is a boolean.
`boolean`	`checkBoolean(int index, boolean d)` Checks if the value of the specified function argument is a boolean.
`byte[]`	`checkByteArray(int index)` Checks if the value of the specified function argument is a string or a number.
`byte[]`	`checkByteArray(int index, byte[] d)` Checks if the value of the specified function argument is a string or a number.
`int`	`checkInteger(int index)` Checks if the value of the specified function argument is a number or a string convertible to a number.
`int`	`checkInteger(int index, int d)` Checks if the value of the specified function argument is a number or a string convertible to a number.
`<T> T`	`checkJavaObject(int index, Class<T> clazz)` Checks if the value of the specified function argument is convertible to a Java object of the specified type.
`<T> T`	`checkJavaObject(int index, Class<T> clazz, T d)` Checks if the value of the specified function argument is convertible to a Java object of the specified type.
`double`	`checkNumber(int index)` Checks if the value of the specified function argument is a number or a string convertible to a number.
`double`	`checkNumber(int index, double d)` Checks if the value of the specified function argument is a number or a string convertible to a number.
`String`	`checkOption(int index, String[] options)` Checks if the value of the specified function argument is a string or a number matching one of the specified options.
`String`	`checkOption(int index, String[] options, String d)` Checks if the value of the specified function argument is a string or a number matching one of the specified options.
`String`	`checkString(int index)` Checks if the value of the specified function argument is a string or a number.
`String`	`checkString(int index, String d)` Checks if the value of the specified function argument is a string or a number.
`void`	`checkType(int index, LuaType type)` Checks if the value of the specified function argument is of the specified type.
`void`	`close()` Closes this Lua state and releases all resources.
`void`	`concat(int n)` Concatenates the specified number values on top of the stack and replaces them with the concatenated value.
`void`	`dump(OutputStream outputStream)` Dumps the function on top of the stack as a pre-compiled binary chunk into an output stream.
`boolean`	`equal(int index1, int index2)` Returns whether the values at two specified stack indexes are equal according to Lua semantics.
`int`	`gc(LuaState.GcAction what, int data)` Performs a garbage collection operation.
`ClassLoader`	`getClassLoader()` Returns the class loader of this Lua state.
`Converter`	`getConverter()` Returns the converter of this Lua state.
`void`	`getFEnv(int index)` Pushes on the stack the environment table of the value at the specified index.
`void`	`getField(int index, String key)` Pushes on the stack the value indexed by the specified string key in the table at the specified index.
`void`	`getGlobal(String name)` Pushes the value of a global variable on the stack.
`JavaReflector`	`getJavaReflector()` Returns the Java reflector of this Lua state.
`boolean`	`getMetafield(int index, String key)` Pushes on the stack the value of the named field in the metatable of the value at the specified index and returns `true`.
`JavaFunction`	`getMetamethod(Object obj, JavaReflector.Metamethod metamethod)` Returns a metamethod for a specified object.
`boolean`	`getMetatable(int index)` Pushes on the stack the metatable of the value at the specified index.
`LuaValueProxy`	`getProxy(int index)` Returns a proxy object for the Lua value at the specified index.
`LuaValueProxy`	`getProxy(int index, Class<?>[] interfaces)` Returns a proxy object implementing the specified list of interfaces in Lua.
`<T> T`	`getProxy(int index, Class<T> interfaze)` Returns a proxy object implementing the specified interface in Lua.
`void`	`getTable(int index)` Pushes on the stack the value indexed by the key on top of the stack in the table at the specified index.
`int`	`getTop()` Returns the number of values on the stack.
`void`	`insert(int index)` Pops the value on top of the stack inserting it at the specified index and moving up elements above that index.
`boolean`	`isBoolean(int index)` Returns whether the value at the specified stack index is a boolean.
`boolean`	`isCFunction(int index)` Returns whether the value at the specified stack index is a C function.
`boolean`	`isFunction(int index)` Returns whether the value at the specified stack index is a function (either a C function, a Java function or a Lua function.)
`boolean`	`isJavaFunction(int index)` Returns whether the value at the specified stack index is a Java function.
`boolean`	`isJavaObject(int index, Class<?> type)` Returns whether the value at the specified stack index is convertible to a Java object of the specified type.
`boolean`	`isJavaObjectRaw(int index)` Returns whether the value at the specified stack index is a Java object.
`boolean`	`isNil(int index)` Returns whether the value at the specified stack index is `nil`.
`boolean`	`isNone(int index)` Returns whether the value at the specified stack index is undefined.
`boolean`	`isNoneOrNil(int index)` Returns whether the value at the specified stack index is undefined or `nil`.
`boolean`	`isNumber(int index)` Returns whether the value at the specified stack index is a number or a string convertible to a number.
`boolean`	`isOpen()` Returns whether this Lua state is open.
`boolean`	`isString(int index)` Returns whether the value at the specified stack index is a string or a number (which is always convertible to a string.)
`boolean`	`isTable(int index)` Returns whether the value at the specified stack index is a table.
`boolean`	`isThread(int index)` Returns whether the value at the specified stack index is a thread.
`int`	`length(int index)` Returns the length of the value at the specified stack index.
`boolean`	`lessThan(int index1, int index2)` Returns whether a value at a first stack index is less than the value at a second stack index according to Lua semantics.
`void`	`load(InputStream inputStream, String chunkName)` Loads a Lua chunk from an input stream and pushes it on the stack as a function.
`void`	`load(String chunk, String chunkName)` Loads a Lua chunk from a string and pushes it on the stack as a function.
`void`	`newTable()` Creates a new table and pushes it on the stack.
`void`	`newTable(int arrayCount, int recordCount)` Creates a new table with pre-allocated space for a number of array elements and record elements and pushes it on the stack.
`void`	`newThread()` Pops the start function of a new Lua thread from the stack and creates the new thread with that start function.
`boolean`	`next(int index)` Pops a key from the stack and pushes on the stack the next key and its value in the table at the specified index.
`void`	`openLib(LuaState.Library library)` Opens the specified library in this Lua state.
`void`	`openLibs()` Opens the Lua standard libraries and the JNLua Java module in this Lua state.
`void`	`pop(int count)` Pops values from the stack.
`void`	`pushBoolean(boolean b)` Pushes a boolean value on the stack.
`void`	`pushInteger(int n)` Pushes an integer value as a number value on the stack.
`void`	`pushJavaFunction(JavaFunction javaFunction)` Pushes a Java function on the stack.
`void`	`pushJavaObject(Object object)` Pushes a Java object on the stack with conversion.
`void`	`pushJavaObjectRaw(Object object)` Pushes a Java object on the stack.
`void`	`pushNil()` Pushes a nil value on the stack.
`void`	`pushNumber(double n)` Pushes a number value on the stack.
`void`	`pushString(byte[] b)` Pushes a byte array as a string value on the stack.
`void`	`pushString(byte[] b, int count)` Pushes a byte array as a string value on the stack.
`void`	`pushString(String s)` Pushes a string value on the stack.
`void`	`pushValue(int index)` Pushes the value at the specified index on top of the stack.
`boolean`	`rawEqual(int index1, int index2)` Bypassing metatable logic, returns whether the values at two specified stack indexes are equal according to Lua semantics.
`void`	`rawGet(int index)` Bypassing metatable logic, pushes on the stack the value indexed by the key on top of the stack in the table at the specified index.
`void`	`rawGet(int index, int key)` Bypassing metatable logic, pushes on the stack the value indexed by the specified integer key in the table at the specified index.
`void`	`rawSet(int index)` Bypassing metatable logic, sets the value on top of the stack in the table at the specified index using the value on the second highest stack position as the key.
`void`	`rawSet(int index, int key)` Bypassing metatable logic, sets the value on top of the stack in the table at the specified index using the specified integer key.
`int`	`ref(int index)` Stores the value on top of the stack in the table at the specified index and returns the integer key of the value in that table as a reference.
`void`	`register(NamedJavaFunction namedJavaFunction)` Registers a named Java function as a global variable.
`void`	`register(String moduleName, NamedJavaFunction[] namedJavaFunctions)` Registers a module and pushes the module on the stack.
`void`	`remove(int index)` Removes the value at the specified stack index moving down elements above that index.
`void`	`replace(int index)` Replaces the value at the specified index with the value popped from the top of the stack.
`int`	`resume(int index, int argCount)` Resumes the thread at the specified stack index, popping the specified number of arguments from the top of the stack and passing them to the resumed thread.
`void`	`setClassLoader(ClassLoader classLoader)` Sets the class loader of this Lua state.
`void`	`setConverter(Converter converter)` Sets the converter of this Lua state.
`boolean`	`setFEnv(int index)` Sets the value on top of the stack as the environment table of the value at the specified index.
`void`	`setField(int index, String key)` Sets the value on top of the stack in the table at the specified index using the specified string key.
`void`	`setGlobal(String name)` Sets the value on top of the stack as a global variable and pops the value from the stack.
`void`	`setJavaReflector(JavaReflector javaReflector)` Sets the Java reflector of this Lua state.
`boolean`	`setMetatable(int index)` Sets the value on top of the stack as the metatable of the value at the specified index.
`void`	`setTable(int index)` Sets the value on top of the stack in the table at the specified index using the value on the second highest stack position as the key.
`void`	`setTop(int index)` Sets the specified index as the new top of the stack.
`int`	`status(int index)` Returns the status of the thread at the specified stack index.
`void`	`tableMove(int index, int from, int to, int count)` Moves the specified number of sequential elements in a table used as an array from one index to another.
`int`	`tableSize(int index)` Counts the number of entries in a table.
`boolean`	`toBoolean(int index)` Returns the boolean representation of the value at the specified stack index.
`byte[]`	`toByteArray(int index)` Returns the byte array representation of the value at the specified stack index.
`int`	`toInteger(int index)` Returns the integer representation of the value at the specified stack index.
`JavaFunction`	`toJavaFunction(int index)` Returns the Java function of the value at the specified stack index.
`<T> T`	`toJavaObject(int index, Class<T> type)` Returns a Java object of the specified type representing the value at the specified stack index.
`Object`	`toJavaObjectRaw(int index)` Returns the Java object of the value at the specified stack index.
`double`	`toNumber(int index)` Returns the number representation of the value at the specified stack index.
`long`	`toPointer(int index)` Returns the pointer representation of the value at the specified stack index.
`String`	`toString(int index)` Returns the string representation of the value at the specified stack index.
`LuaType`	`type(int index)` Returns the type of the value at the specified stack index.
`String`	`typeName(int index)` Returns the name of the type at the specified stack index.
`void`	`unref(int index, int reference)` Removes a previously created reference from the table at the specified index.
`int`	`yield(int returnCount)` Yields the running thread, popping the specified number of values from the top of the stack and passing them as return values to the thread which has resumed the running thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REGISTRYINDEX
```
public static final int REGISTRYINDEX
```
    Registry pseudo-index.
    
    See Also:
    Constant Field Values
  - ENVIRONINDEX
```
public static final int ENVIRONINDEX
```
    Environment pseudo-index.
    
    See Also:
    Constant Field Values
  - GLOBALSINDEX
```
public static final int GLOBALSINDEX
```
    Globals pseudo-index.
    
    See Also:
    Constant Field Values
  - MULTRET
```
public static final int MULTRET
```
    Multiple returns pseudo return value count.
    
    See Also:
    Constant Field Values
  - YIELD
```
public static final int YIELD
```
    Status indicating that a thread is suspended.
    
    See Also:
    Constant Field Values
  - VERSION
```
public static final String VERSION
```
    The JNLua version. The format is <major>.<minor>.
    
    See Also:
    Constant Field Values
  - LUA_VERSION
```
public static final String LUA_VERSION
```
    The Lua version. The format is <major>.<minor>.
- Constructor Detail
  - LuaState
```
public LuaState()
```
    Creates a new instance. The class loader of this Lua state is set to the context class loader of the calling thread. The Java reflector and the converter are initialized with the default implementations.
    
    See Also:
    getClassLoader(), setClassLoader(ClassLoader), getJavaReflector(), setJavaReflector(JavaReflector), getConverter(), setConverter(Converter)
  - LuaState
```
public LuaState(long luaState)
```
    Creates a new instance.
- Method Detail
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Returns the class loader of this Lua state. The class loader is used for dynamically loading classes.
    The method may be invoked on a closed Lua state.
    
    Returns:
    the class loader
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Sets the class loader of this Lua state. The class loader is used for dynamically loading classes.
    The method may be invoked on a closed Lua state.
    
    Parameters:
    classLoader - the class loader to set
  - getJavaReflector
```
public JavaReflector getJavaReflector()
```
    Returns the Java reflector of this Lua state.
    The method may be invoked on a closed Lua state.
    
    Returns:
    the Java reflector converter
  - setJavaReflector
```
public void setJavaReflector(JavaReflector javaReflector)
```
    Sets the Java reflector of this Lua state.
    The method may be invoked on a closed Lua state.
    
    Parameters:
    javaReflector - the Java reflector
  - getMetamethod
```
public JavaFunction getMetamethod(Object obj,
                         JavaReflector.Metamethod metamethod)
```
    Returns a metamethod for a specified object. If the object implements the JavaReflector interface, the metamethod is first queried from the object. If the object provides the requested metamethod, that metamethod is returned. Otherwise, the method returns the metamethod provided by the Java reflector configured in this Lua state.
    Clients requiring access to metamethods should go by this method to ensure consistent class-by-class overriding of the Java reflector.
    
    Parameters:
    obj - the object, or null
    
    Returns:
    the Java reflector
  - getConverter
```
public Converter getConverter()
```
    Returns the converter of this Lua state.
    The method may be invoked on a closed Lua state.
    
    Returns:
    the converter
  - setConverter
```
public void setConverter(Converter converter)
```
    Sets the converter of this Lua state.
    The method may be invoked on a closed Lua state.
    
    Parameters:
    converter - the converter
  - isOpen
```
public final boolean isOpen()
```
    Returns whether this Lua state is open.
    The method may be invoked on a closed Lua state.
    
    Returns:
    whether this Lua state is open
  - close
```
public void close()
```
    Closes this Lua state and releases all resources.
    The method may be invoked on a closed Lua state and has no effect in that case.
  - gc
```
public int gc(LuaState.GcAction what,
     int data)
```
    Performs a garbage collection operation.
    
    Parameters:
    what - the operation to perform
    data - the argument required by some operations (see Lua Reference Manual)
    
    Returns:
    a return value depending on the GC operation performed (see Lua Reference Manual)
  - openLib
```
public void openLib(LuaState.Library library)
```
    Opens the specified library in this Lua state.
    
    Parameters:
    library - the library
  - openLibs
```
public void openLibs()
```
    Opens the Lua standard libraries and the JNLua Java module in this Lua state.
    The method opens all libraries defined by the LuaState.Library enumeration.
  - register
```
public void register(NamedJavaFunction namedJavaFunction)
```
    Registers a named Java function as a global variable.
    
    Parameters:
    namedJavaFunction - the Java function to register
  - register
```
public void register(String moduleName,
            NamedJavaFunction[] namedJavaFunctions)
```
    Registers a module and pushes the module on the stack. The module name is allowed to contain dots to define module hierarchies.
    
    Parameters:
    moduleName - the module name
    namedJavaFunctions - the Java functions of the module
  - load
```
public void load(InputStream inputStream,
        String chunkName)
          throws IOException
```
    Loads a Lua chunk from an input stream and pushes it on the stack as a function. The Lua chunk must be either a UTF-8 encoded source chunk or a pre-compiled binary chunk.
    
    Parameters:
    inputStream - the input stream
    chunkName - the name of the chunk for use in error messages
    
    Throws:
    
    IOException - if an IO error occurs
  - load
```
public void load(String chunk,
        String chunkName)
```
    Loads a Lua chunk from a string and pushes it on the stack as a function. The string must contain a source chunk.
    
    Parameters:
    chunk - the Lua source chunk
    chunkName - the name of the chunk for use in error messages
  - dump
```
public void dump(OutputStream outputStream)
          throws IOException
```
    Dumps the function on top of the stack as a pre-compiled binary chunk into an output stream.
    
    Parameters:
    outputStream - the output stream
    
    Throws:
    
    IOException - if an IO error occurs
  - call
```
public void call(int argCount,
        int returnCount)
```
    Calls a Lua function. The function to call and the specified number of arguments are on the stack. After the call, the specified number of returns values are on stack. If the number of return values has been specified as MULTRET, the number of values on the stack corresponds the to number of values actually returned by the called function.
    
    Parameters:
    argCount - the number of arguments
    returnCount - the number of return values, or MULTRET to accept all values returned by the function
  - getGlobal
```
public void getGlobal(String name)
```
    Pushes the value of a global variable on the stack.
    
    Parameters:
    name - the global variable name
  - setGlobal
```
public void setGlobal(String name)
               throws LuaMemoryAllocationException,
                      LuaRuntimeException
```
    Sets the value on top of the stack as a global variable and pops the value from the stack.
    
    Parameters:
    name - the global variable name
    
    Throws:
    
    LuaMemoryAllocationException
    
    LuaRuntimeException
  - pushBoolean
```
public void pushBoolean(boolean b)
```
    Pushes a boolean value on the stack.
    
    Parameters:
    b - the boolean value to push
  - pushInteger
```
public void pushInteger(int n)
```
    Pushes an integer value as a number value on the stack.
    
    Parameters:
    n - the integer value to push
  - pushJavaFunction
```
public void pushJavaFunction(JavaFunction javaFunction)
```
    Pushes a Java function on the stack.
    
    Parameters:
    javaFunction - the function to push
  - pushJavaObjectRaw
```
public void pushJavaObjectRaw(Object object)
```
    Pushes a Java object on the stack. The object is pushed "as is", i.e. without conversion.
    If you require to push a Lua value that represents the Java object, then invoke pushJavaObject(object).
    
    You cannot push null without conversion since null is not a Java object. The converter converts null to nil.
    
    Parameters:
    object - the Java object
    See Also:
    pushJavaObject(Object)
  - pushJavaObject
```
public void pushJavaObject(Object object)
```
    Pushes a Java object on the stack with conversion. The object is processed the by the configured converter.
    
    Parameters:
    object - the Java object
    See Also:
    getConverter(), setConverter(Converter)
  - pushNil
```
public void pushNil()
```
    Pushes a nil value on the stack.
  - pushNumber
```
public void pushNumber(double n)
```
    Pushes a number value on the stack.
    
    Parameters:
    n - the number to push
  - pushString
```
public void pushString(String s)
```
    Pushes a string value on the stack.
    
    Parameters:
    s - the string value to push
  - pushString
```
public void pushString(byte[] b)
```
    Pushes a byte array as a string value on the stack.
    
    Parameters:
    b - the byte array to push
  - pushString
```
public void pushString(byte[] b,
              int count)
```
    Pushes a byte array as a string value on the stack.
    
    Parameters:
    b - the byte array to push
    count - the number of bytes in the array to push, starting from index zero
  - isBoolean
```
public boolean isBoolean(int index)
```
    Returns whether the value at the specified stack index is a boolean.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a boolean
  - isCFunction
```
public boolean isCFunction(int index)
```
    Returns whether the value at the specified stack index is a C function.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a function
  - isFunction
```
public boolean isFunction(int index)
```
    Returns whether the value at the specified stack index is a function (either a C function, a Java function or a Lua function.)
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a function
  - isJavaFunction
```
public boolean isJavaFunction(int index)
```
    Returns whether the value at the specified stack index is a Java function.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a function
  - isJavaObjectRaw
```
public boolean isJavaObjectRaw(int index)
```
    Returns whether the value at the specified stack index is a Java object.
    Note that the method does not perform conversion. If you want to check if a value is convertible to a Java object, then invoke isJavaObject(index, Object.class).
    
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a Java object
    See Also:
    isJavaObject(int, Class)
  - isJavaObject
```
public boolean isJavaObject(int index,
                   Class<?> type)
```
    Returns whether the value at the specified stack index is convertible to a Java object of the specified type. The conversion is checked by the configured converter.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is convertible to a Java object of the specified type
    See Also:
    setConverter(Converter), getConverter()
  - isNil
```
public boolean isNil(int index)
```
    Returns whether the value at the specified stack index is nil.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is nil
  - isNone
```
public boolean isNone(int index)
```
    Returns whether the value at the specified stack index is undefined.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is undefined
  - isNoneOrNil
```
public boolean isNoneOrNil(int index)
```
    Returns whether the value at the specified stack index is undefined or nil.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is undefined
  - isNumber
```
public boolean isNumber(int index)
```
    Returns whether the value at the specified stack index is a number or a string convertible to a number.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a number or a string convertible to a number
  - isString
```
public boolean isString(int index)
```
    Returns whether the value at the specified stack index is a string or a number (which is always convertible to a string.)
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a string or a number
  - isTable
```
public boolean isTable(int index)
```
    Returns whether the value at the specified stack index is a table.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a table
  - isThread
```
public boolean isThread(int index)
```
    Returns whether the value at the specified stack index is a thread.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    whether the value is a thread
  - equal
```
public boolean equal(int index1,
            int index2)
```
    Returns whether the values at two specified stack indexes are equal according to Lua semantics.
    
    Parameters:
    index1 - the first stack index
    index2 - the second stack index
    
    Returns:
    whether the values are equal
  - lessThan
```
public boolean lessThan(int index1,
               int index2)
                 throws LuaMemoryAllocationException,
                        LuaRuntimeException
```
    Returns whether a value at a first stack index is less than the value at a second stack index according to Lua semantics.
    
    Parameters:
    index1 - the first stack index
    index2 - the second stack index
    
    Returns:
    whether the value at the first index is less than the value at the second index
    
    Throws:
    
    LuaMemoryAllocationException
    
    LuaRuntimeException
  - length
```
public int length(int index)
```
    Returns the length of the value at the specified stack index. The definition of the length depends on the type of the value. For strings, it is the length of the string, for tables it is the result of the length operator. For other types, the return value is undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    the length
  - rawEqual
```
public boolean rawEqual(int index1,
               int index2)
```
    Bypassing metatable logic, returns whether the values at two specified stack indexes are equal according to Lua semantics.
    
    Parameters:
    index1 - the first stack index
    index2 - the second stack index
    
    Returns:
    whether the values are equal
  - toBoolean
```
public boolean toBoolean(int index)
```
    Returns the boolean representation of the value at the specified stack index. The boolean representation is true for all values except false and nil.
    
    Parameters:
    index - the stack index
    
    Returns:
    the boolean representation of the value
  - toByteArray
```
public byte[] toByteArray(int index)
```
    Returns the byte array representation of the value at the specified stack index. The value must be a string or a number. If the value is a number, it is in place converted to a string. Otherwise, the method returns null.
    
    Parameters:
    index - the stack index
    
    Returns:
    the byte array representation of the value
  - toInteger
```
public int toInteger(int index)
```
    Returns the integer representation of the value at the specified stack index. The value must be a number or a string convertible to a number. Otherwise, the method returns 0.
    
    Parameters:
    index - the stack index
    
    Returns:
    the integer representation, or 0
  - toJavaFunction
```
public JavaFunction toJavaFunction(int index)
```
    Returns the Java function of the value at the specified stack index. If the value is not a Java function, the method returns null.
    
    Parameters:
    index - the stack index
    
    Returns:
    the Java function, or null
  - toJavaObjectRaw
```
public Object toJavaObjectRaw(int index)
```
    Returns the Java object of the value at the specified stack index. If the value is not a Java object, the method returns null.
    Note that the method does not convert values to Java objects. If you require any Java object that represents the value at the specified index, then invoke toJavaObject(index, Object.class).
    
    Parameters:
    index - the stack index
    
    Returns:
    the Java object, or null
    See Also:
    toJavaObject(int, Class)
  - toJavaObject
```
public <T> T toJavaObject(int index,
                 Class<T> type)
```
    Returns a Java object of the specified type representing the value at the specified stack index. The value must be convertible to a Java object of the specified type. The conversion is executed by the configured converter.
    
    Parameters:
    index - the stack index
    type - the Java type to convert to
    
    Returns:
    the object
    
    Throws:
    
    ClassCastException - if the conversion is not supported by the converter
    See Also:
    getConverter(), setConverter(Converter)
  - toNumber
```
public double toNumber(int index)
```
    Returns the number representation of the value at the specified stack index. The value must be a number or a string convertible to a number. Otherwise, the method returns 0.0.
    
    Parameters:
    index - the stack index
    
    Returns:
    the number representation, or 0.0
  - toPointer
```
public long toPointer(int index)
```
    Returns the pointer representation of the value at the specified stack index. The value must be a table, thread, function or userdata (such as a Java object.) Otherwise, the method returns 0L. Different values return different pointers. Other than that, the returned value has no portable significance.
    
    Parameters:
    index - the stack index
    
    Returns:
    the pointer representation, or 0L if none
  - toString
```
public String toString(int index)
```
    Returns the string representation of the value at the specified stack index. The value must be a string or a number. If the value is a number, it is in place converted to a string. Otherwise, the method returns null.
    
    Parameters:
    index - the stack index
    
    Returns:
    the string representation, or null
  - type
```
public LuaType type(int index)
```
    Returns the type of the value at the specified stack index.
    The stack index may be undefined.
    
    Parameters:
    index - the stack index
    
    Returns:
    the type, or null if the stack index is undefined
  - typeName
```
public String typeName(int index)
```
    Returns the name of the type at the specified stack index. The type name is the display text for the Lua type except for Java objects where the type name is the canonical class name.
    The stack index may be undefined.
    
    Parameters:
    index - the index
    
    Returns:
    the type name
    See Also:
    LuaType.displayText(), Class.getCanonicalName()
  - concat
```
public void concat(int n)
```
    Concatenates the specified number values on top of the stack and replaces them with the concatenated value.
    
    Parameters:
    n - the number of values to concatenate
  - getTop
```
public int getTop()
```
    Returns the number of values on the stack.
    
    Returns:
    the number of values on the tack
  - insert
```
public void insert(int index)
```
    Pops the value on top of the stack inserting it at the specified index and moving up elements above that index.
    
    Parameters:
    index - the stack index
  - pop
```
public void pop(int count)
```
    Pops values from the stack.
    
    Parameters:
    count - the number of values to pop
  - pushValue
```
public void pushValue(int index)
```
    Pushes the value at the specified index on top of the stack.
    
    Parameters:
    index - the stack index
  - remove
```
public void remove(int index)
```
    Removes the value at the specified stack index moving down elements above that index.
    
    Parameters:
    index - the stack index
  - replace
```
public void replace(int index)
```
    Replaces the value at the specified index with the value popped from the top of the stack.
    
    Parameters:
    index - the stack index
  - setTop
```
public void setTop(int index)
```
    Sets the specified index as the new top of the stack.
    The new top of the stack may be above the current top of the stack. In this case, new values are set to nil.
    
    Parameters:
    index - the index of the new top of the stack
  - getTable
```
public void getTable(int index)
```
    Pushes on the stack the value indexed by the key on top of the stack in the table at the specified index. The key is replaced by the value from the table.
    
    Parameters:
    index - the stack index containing the table
  - getField
```
public void getField(int index,
            String key)
```
    Pushes on the stack the value indexed by the specified string key in the table at the specified index.
    
    Parameters:
    index - the stack index containing the table
    key - the string key
  - newTable
```
public void newTable()
```
    Creates a new table and pushes it on the stack.
  - newTable
```
public void newTable(int arrayCount,
            int recordCount)
```
    Creates a new table with pre-allocated space for a number of array elements and record elements and pushes it on the stack.
    
    Parameters:
    arrayCount - the number of array elements
    recordCount - the number of record elements
  - next
```
public boolean next(int index)
```
    Pops a key from the stack and pushes on the stack the next key and its value in the table at the specified index. If there is no next key, the key is popped but nothing is pushed. The method returns whether there is a next key.
    
    Parameters:
    index - the stack index containing the table
    
    Returns:
    whether there is a next key
  - rawGet
```
public void rawGet(int index)
```
    Bypassing metatable logic, pushes on the stack the value indexed by the key on top of the stack in the table at the specified index. The key is replaced by the value from the table.
    
    Parameters:
    index - the stack index containing the table
  - rawGet
```
public void rawGet(int index,
          int key)
```
    Bypassing metatable logic, pushes on the stack the value indexed by the specified integer key in the table at the specified index.
    
    Parameters:
    index - the stack index containing the table
    key - the integer key
  - rawSet
```
public void rawSet(int index)
```
    Bypassing metatable logic, sets the value on top of the stack in the table at the specified index using the value on the second highest stack position as the key. Both the value and the key are popped from the stack.
    
    Parameters:
    index - the stack index containing the table
  - rawSet
```
public void rawSet(int index,
          int key)
```
    Bypassing metatable logic, sets the value on top of the stack in the table at the specified index using the specified integer key. The value is popped from the stack.
    
    Parameters:
    index - the stack index containing the table
    key - the integer key
  - setTable
```
public void setTable(int index)
```
    Sets the value on top of the stack in the table at the specified index using the value on the second highest stack position as the key. Both the value and the key are popped from the stack.
    
    Parameters:
    index - the stack index containing the table
  - setField
```
public void setField(int index,
            String key)
```
    Sets the value on top of the stack in the table at the specified index using the specified string key. The value is popped from the stack.
    
    Parameters:
    index - the stack index containing the table
    key - the string key
  - getMetafield
```
public boolean getMetafield(int index,
                   String key)
```
    Pushes on the stack the value of the named field in the metatable of the value at the specified index and returns true. If the value does not have a metatable or if the metatable does not contain the named field, nothing is pushed and the method returns false.
    
    Parameters:
    index - the stack index containing the value to get the metafield from
    key - the string key
    
    Returns:
    whether the metafield was pushed on the stack
  - getMetatable
```
public boolean getMetatable(int index)
```
    Pushes on the stack the metatable of the value at the specified index. If the value does not have a metatable, the method returns false and nothing is pushed.
    
    Parameters:
    index - the stack index containing the value to get the metatable from
    
    Returns:
    whether the metatable was pushed on the stack
  - setMetatable
```
public boolean setMetatable(int index)
```
    Sets the value on top of the stack as the metatable of the value at the specified index. The metatable to be set is popped from the stack regardless whether it can be set or not.
    
    Parameters:
    index - the stack index containing the value to set the metatable for
    
    Returns:
    whether the metatable was set
  - getFEnv
```
public void getFEnv(int index)
```
    Pushes on the stack the environment table of the value at the specified index. If the value does not have an environment table, nil is pushed on the stack.
    
    Parameters:
    index - the stack index containing the value to get the environment table from
  - setFEnv
```
public boolean setFEnv(int index)
```
    Sets the value on top of the stack as the environment table of the value at the specified index. The environment table to be set is popped from the stack regardless whether it can be set or not.
    
    Parameters:
    index - the stack index containing the value to set the environment table for
    
    Returns:
    whether the environment table was set
  - newThread
```
public void newThread()
```
    Pops the start function of a new Lua thread from the stack and creates the new thread with that start function. The new thread is pushed on the stack.
  - resume
```
public int resume(int index,
         int argCount)
```
    Resumes the thread at the specified stack index, popping the specified number of arguments from the top of the stack and passing them to the resumed thread. The method returns the number of values pushed on the stack as the return values of the resumed thread.
    
    Parameters:
    index - the stack index containing the thread
    argCount - the number of arguments to pass
    
    Returns:
    the number of values returned by the thread
  - status
```
public int status(int index)
```
    Returns the status of the thread at the specified stack index. If the thread is in initial state of has finished its execution, the method returns 0. If the thread has yielded, the method returns YIELD. Other return values indicate errors for which an exception has been thrown.
    
    Parameters:
    index - the index
    
    Returns:
    the status
  - yield
```
public int yield(int returnCount)
```
    Yields the running thread, popping the specified number of values from the top of the stack and passing them as return values to the thread which has resumed the running thread. The method must be used exclusively at the exit point of Java functions, i.e. return luaState.yield(n).
    
    Parameters:
    returnCount - the number of results to pass
    
    Returns:
    the return value of the Java function
  - ref
```
public int ref(int index)
```
    Stores the value on top of the stack in the table at the specified index and returns the integer key of the value in that table as a reference. The value is popped from the stack.
    
    Parameters:
    index - the stack index containing the table where to store the value
    
    Returns:
    the reference integer key
    See Also:
    unref(int, int)
  - unref
```
public void unref(int index,
         int reference)
```
    Removes a previously created reference from the table at the specified index. The value is removed from the table and its integer key of the reference is freed for reuse.
    
    Parameters:
    index - the stack index containing the table where the value was stored
    reference - the reference integer key
    See Also:
    ref(int)
  - tableSize
```
public int tableSize(int index)
```
    Counts the number of entries in a table.
    The method provides optimized performance over a Java implementation of the same functionality due to the reduced number of JNI transitions.
    
    Parameters:
    index - the stack index containing the table
    
    Returns:
    the number of entries in the table
  - tableMove
```
public void tableMove(int index,
             int from,
             int to,
             int count)
```
    Moves the specified number of sequential elements in a table used as an array from one index to another.
    The method provides optimized performance over a Java implementation of the same functionality due to the reduced number of JNI transitions.
    
    Parameters:
    index - the stack index containing the table
    from - the index to move from
    to - the index to move to
    count - the number of elements to move
  - checkArg
```
public void checkArg(int index,
            boolean condition,
            String msg)
```
    Checks if a condition is true for the specified function argument. If not, the method throws a Lua runtime exception with the specified error message.
    
    Parameters:
    index - the argument index
    condition - the condition
    msg - the error message
  - checkBoolean
```
public boolean checkBoolean(int index)
```
    Checks if the value of the specified function argument is a boolean. If so, the argument value is returned as a boolean. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    
    Returns:
    the boolean value, or the default value
  - checkBoolean
```
public boolean checkBoolean(int index,
                   boolean d)
```
    Checks if the value of the specified function argument is a boolean. If so, the argument value is returned as a boolean. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    d - the default value
    
    Returns:
    the boolean value
  - checkByteArray
```
public byte[] checkByteArray(int index)
```
    Checks if the value of the specified function argument is a string or a number. If so, the argument value is returned as a byte array. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    
    Returns:
    the byte array value
  - checkByteArray
```
public byte[] checkByteArray(int index,
                    byte[] d)
```
    Checks if the value of the specified function argument is a string or a number. If so, the argument value is returned as a byte array. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    d - the default value
    
    Returns:
    the string value, or the default value
  - checkInteger
```
public int checkInteger(int index)
```
    Checks if the value of the specified function argument is a number or a string convertible to a number. If so, the argument value is returned as an integer. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    
    Returns:
    the integer value
  - checkInteger
```
public int checkInteger(int index,
               int d)
```
    Checks if the value of the specified function argument is a number or a string convertible to a number. If so, the argument value is returned as an integer. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    d - the default value
    
    Returns:
    the integer value, or the default value
  - checkNumber
```
public double checkNumber(int index)
```
    Checks if the value of the specified function argument is a number or a string convertible to a number. If so, the argument value is returned as a number. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    
    Returns:
    the number value
  - checkNumber
```
public double checkNumber(int index,
                 double d)
```
    Checks if the value of the specified function argument is a number or a string convertible to a number. If so, the argument value is returned as a number. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    d - the default value
    
    Returns:
    the number value, or the default value
  - checkJavaObject
```
public <T> T checkJavaObject(int index,
                    Class<T> clazz)
```
    Checks if the value of the specified function argument is convertible to a Java object of the specified type. If so, the argument value is returned as a Java object of the specified type. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    Note that the converter converts nil to null. Therefore, the method may return null if the value is nil.
    
    Parameters:
    index - the argument index
    clazz - the expected type
    
    Returns:
    the Java object, or null
  - checkJavaObject
```
public <T> T checkJavaObject(int index,
                    Class<T> clazz,
                    T d)
```
    Checks if the value of the specified function argument is convertible to a Java object of the specified type. If so, the argument value is returned as a Java object of the specified type. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    clazz - the expected class
    d - the default value
    
    Returns:
    the Java object, or the default value
  - checkOption
```
public String checkOption(int index,
                 String[] options)
```
    Checks if the value of the specified function argument is a string or a number matching one of the specified options. If so, the argument value is returned as a string. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    options - the options
    
    Returns:
    the string value
  - checkOption
```
public String checkOption(int index,
                 String[] options,
                 String d)
```
    Checks if the value of the specified function argument is a string or a number matching one of the specified options. If so, argument value is returned as a string. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    options - the options
    d - the default value
    
    Returns:
    the string value, or the default value
  - checkString
```
public String checkString(int index)
```
    Checks if the value of the specified function argument is a string or a number. If so, the argument value is returned as a string. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    
    Returns:
    the string value
  - checkString
```
public String checkString(int index,
                 String d)
```
    Checks if the value of the specified function argument is a string or a number. If so, the argument value is returned as a string. If the value of the specified argument is undefined or nil, the method returns the specified default value. Otherwise, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    d - the default value
    
    Returns:
    the string value, or the default value
  - checkType
```
public void checkType(int index,
             LuaType type)
```
    Checks if the value of the specified function argument is of the specified type. If not, the method throws a Lua runtime exception with a descriptive error message.
    
    Parameters:
    index - the argument index
    type - the type
  - getProxy
```
public LuaValueProxy getProxy(int index)
```
    Returns a proxy object for the Lua value at the specified index.
    
    Parameters:
    index - the stack index containing the Lua value
    
    Returns:
    the Lua value proxy
  - getProxy
```
public <T> T getProxy(int index,
             Class<T> interfaze)
```
    Returns a proxy object implementing the specified interface in Lua. The table at the specified stack index contains the method names from the interface as keys and the Lua functions implementing the interface methods as values. The returned object always implements the LuaValueProxy interface in addition to the specified interface.
    
    Parameters:
    index - the stack index containing the table
    interfaze - the interface
    
    Returns:
    the proxy object
  - getProxy
```
public LuaValueProxy getProxy(int index,
                     Class<?>[] interfaces)
```
    Returns a proxy object implementing the specified list of interfaces in Lua. The table at the specified stack index contains the method names from the interfaces as keys and the Lua functions implementing the interface methods as values. The returned object always implements the LuaValueProxy interface in addition to the specified interfaces.
    
    Parameters:
    index - the stack index containing the table
    interfaces - the interfaces
    
    Returns:
    the proxy object

Class LuaState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REGISTRYINDEX

ENVIRONINDEX

GLOBALSINDEX

MULTRET

YIELD

VERSION

LUA_VERSION

Constructor Detail

LuaState

LuaState

Method Detail

getClassLoader

setClassLoader

getJavaReflector

setJavaReflector

getMetamethod

getConverter

setConverter

isOpen

close

gc

openLib

openLibs

register

register

load

load

dump

call

getGlobal

setGlobal

pushBoolean

pushInteger

pushJavaFunction

pushJavaObjectRaw

pushJavaObject

pushNil

pushNumber

pushString

pushString

pushString

isBoolean

isCFunction

isFunction

isJavaFunction

isJavaObjectRaw

isJavaObject

isNil

isNone

isNoneOrNil

isNumber

isString

isTable

isThread

equal

lessThan

length

rawEqual

toBoolean

toByteArray

toInteger

toJavaFunction

toJavaObjectRaw

toJavaObject

toNumber

toPointer

toString

type

typeName

concat

getTop

insert

pop