LuaType (Rembulan Runtime 0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<LuaType>
- - net.sandius.rembulan.LuaType

All Implemented Interfaces:

Serializable, Comparable<LuaType>
```
public enum LuaType
extends Enum<LuaType>
```
An enum representing a Lua type.
There are eight types in Lua (nil, boolean, number, string, function, userdata, thread and table). In Rembulan, all Java object references are mapped to a Lua type according to the following list:
- NIL ... no explicit nil type; any (Java) null value is considered nil
- BOOLEAN ... instances of java.lang.Boolean
- NUMBER ... instances of java.lang.Number:
  - float ... java.lang.Double (canonical) or java.lang.Float
  - integer ... any other subclass of java.lang.Number, with java.lang.Long being the canonical representation
- STRING ... instances of java.lang.String
- FUNCTION ... LuaFunction
- USERDATA:
  - full userdata ... Userdata
  - light userdata ... instances of any class other than those mentioned in this list
- THREAD ... Coroutine
- TABLE ... Table
For numeric values, the canonical representation is the default, full-precision representation of the number as either a float or integer. To convert a number to its canonical value, use Conversions.toCanonicalNumber(Number).

To retrieve the name of the type of a Lua value, use the ValueTypeNamer interface (for names based on the type only, without taking into account the __name metamethod, use PlainValueTypeNamer).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOOLEAN` The Lua `boolean` type, corresponding to instances of `java.lang.Boolean`.
`FUNCTION` The Lua `function` type, corresponding to instances of `LuaFunction`.
`NIL` The Lua `nil` type, corresponding to `null` references.
`NUMBER` The Lua `number` type, corresponding to instances of `java.lang.Number`.
`STRING` The Lua `string` type, corresponding to instances of `ByteString` and `java.lang.String`.
`TABLE` The Lua `table` type, corresponding to instances of `Table`.
`THREAD` The Lua `thread` type, corresponding to instances of the `Coroutine` class.
`USERDATA` The Lua `userdata` type, corresponding to instances of `Userdata` (for full userdata), or any other subclasses of `Object` not mapped to a Lua type (for light userdata).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`isBoolean(Object o)` Returns `true` iff `o` is a Lua boolean.
`static boolean`	`isFloat(Object o)` Returns `true` iff `o` is a Lua float.
`static boolean`	`isFullUserdata(Object o)` Returns `true` iff `o` is full userdata.
`static boolean`	`isFunction(Object o)` Returns `true` iff `o` is a Lua function.
`static boolean`	`isInteger(Object o)` Returns `true` iff `o` is a Lua integer.
`static boolean`	`isLightUserdata(Object o)` Returns `true` iff the object `o` is light userdata.
`static boolean`	`isNil(Object o)` Returns `true` iff `o` is nil.
`static boolean`	`isNumber(Object o)` Returns `true` iff `o` is a Lua number.
`static boolean`	`isString(Object o)` Returns `true` iff `o` is a Lua string.
`static boolean`	`isTable(Object o)` Returns `true` iff the object `o` is a Lua table.
`static boolean`	`isThread(Object o)` Returns `true` iff the object `o` is a Lua thread.
`static boolean`	`isUserdata(Object o)` Returns `true` iff `o` is a Lua userdata.
`static LuaType`	`typeOf(Object o)` Returns the Lua type of the object `o`.
`static LuaType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LuaType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NIL
```
public static final LuaType NIL
```
    The Lua nil type, corresponding to null references.
  - BOOLEAN
```
public static final LuaType BOOLEAN
```
    The Lua boolean type, corresponding to instances of java.lang.Boolean.
  - NUMBER
```
public static final LuaType NUMBER
```
    The Lua number type, corresponding to instances of java.lang.Number.
    Instances of java.lang.Double and java.lang.Float are mapped to Lua floats (Doubles being the canonical representation). All other subclasses of Number are mapped to Lua integers, with java.lang.Long being the canonical representation.
  - STRING
```
public static final LuaType STRING
```
    The Lua string type, corresponding to instances of ByteString and java.lang.String.
  - FUNCTION
```
public static final LuaType FUNCTION
```
    The Lua function type, corresponding to instances of LuaFunction.
  - USERDATA
```
public static final LuaType USERDATA
```
    The Lua userdata type, corresponding to instances of Userdata (for full userdata), or any other subclasses of Object not mapped to a Lua type (for light userdata).
  - THREAD
```
public static final LuaType THREAD
```
    The Lua thread type, corresponding to instances of the Coroutine class.
  - TABLE
```
public static final LuaType TABLE
```
    The Lua table type, corresponding to instances of Table.
- Method Detail
  - values
```
public static LuaType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (LuaType c : LuaType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LuaType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - typeOf
```
public static LuaType typeOf(Object o)
```
    Returns the Lua type of the object o.
    
    Parameters:
    
    o - the object to determine the type of, may be null
    
    Returns:
    
    the Lua type of o
  - isNil
```
public static boolean isNil(Object o)
```
    Returns true iff o is nil.
    o is nil if and only if o is null.
    
    Parameters:
    
    o - the object to test for being nil, may be null
    
    Returns:
    
    true iff o is nil
  - isBoolean
```
public static boolean isBoolean(Object o)
```
    Returns true iff o is a Lua boolean.
    o is a Lua boolean if and only if o is an instance of java.lang.Boolean.
    
    Parameters:
    
    o - the object to test for being a boolean, may be null
    
    Returns:
    
    true iff o is a Lua boolean
  - isNumber
```
public static boolean isNumber(Object o)
```
    Returns true iff o is a Lua number.
    o is a Lua number if and only if o is an instance of java.lang.Number.
    
    Parameters:
    
    o - the object to test for being a number, may be null
    
    Returns:
    
    true iff o is a Lua number
  - isFloat
```
public static boolean isFloat(Object o)
```
    Returns true iff o is a Lua float.
    o is a Lua float if and only if o is an instance of java.lang.Double or java.lang.Float.
    
    Parameters:
    
    o - the object to test for being a float, may be null
    
    Returns:
    
    true iff o is a Lua float
  - isInteger
```
public static boolean isInteger(Object o)
```
    Returns true iff o is a Lua integer.
    o is a Lua number if and only if o is a Lua number and is not a Lua float.
    
    Parameters:
    
    o - the object to test for being an integer, may be null
    
    Returns:
    
    true iff o is a Lua integer
  - isString
```
public static boolean isString(Object o)
```
    Returns true iff o is a Lua string.
    o is a Lua string if and only if o is an instance of ByteString or java.lang.String.
    
    Parameters:
    
    o - the object to test for being a string, may be null
    
    Returns:
    
    true iff o is a Lua string
  - isFunction
```
public static boolean isFunction(Object o)
```
    Returns true iff o is a Lua function.
    o is a Lua function if and only if o is an instance of LuaFunction.
    
    Parameters:
    
    o - the object to test for being a function, may be null
    
    Returns:
    
    true iff o is a Lua function
  - isUserdata
```
public static boolean isUserdata(Object o)
```
    Returns true iff o is a Lua userdata.
    o is a Lua userdata if it is not nil, boolean, number, string, function, thread or table.
    
    Parameters:
    
    o - the object to test for being a userdata, may be null
    
    Returns:
    
    true iff o is a Lua userdata
  - isFullUserdata
```
public static boolean isFullUserdata(Object o)
```
    Returns true iff o is full userdata.
    o is full userdata if and only if o is an instance of Userdata.
    
    Parameters:
    
    o - the object to test for being full userdata, may be null
    
    Returns:
    
    true iff o is full userdata
  - isLightUserdata
```
public static boolean isLightUserdata(Object o)
```
    Returns true iff the object o is light userdata.
    An object is light userdata when its Lua type is USERDATA and it is not an instance of the Userdata class. In other words, it is not an instance of any class mapped to a Lua type.
    
    Parameters:
    
    o - the object to test for being light userdata, may be null
    
    Returns:
    
    true iff o is light userdata
  - isThread
```
public static boolean isThread(Object o)
```
    Returns true iff the object o is a Lua thread.
    o is a Lua thread if and only if o is an instance of Coroutine.
    
    Parameters:
    
    o - the object to test for being a Lua thread, may be null
    
    Returns:
    
    true iff o is a Lua thread
  - isTable
```
public static boolean isTable(Object o)
```
    Returns true iff the object o is a Lua table.
    o is a Lua table if and only if o is an instance of Table.
    
    Parameters:
    
    o - the object to test for being a Lua table, may be null
    
    Returns:
    
    true iff o is a Lua table

Enum LuaType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NIL

BOOLEAN

NUMBER

STRING

FUNCTION

USERDATA

THREAD

TABLE

Method Detail

values

valueOf

typeOf

isNil

isBoolean

isNumber

isFloat

isInteger

isString

isFunction

isUserdata

isFullUserdata

isLightUserdata

isThread

isTable