LuaFormat (Rembulan Runtime 0.1-SNAPSHOT API)

java.lang.Object
- net.sandius.rembulan.LuaFormat

```
public final class LuaFormat
extends Object
```
Static methods for parsing and generating lexical strings following the Lua lexical conventions.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`CHAR_BELL` The '\a' character.
`static char`	`CHAR_VERTICAL_TAB` The '\v' character.
`static ByteString`	`FALSE` The byte string representation of false.
`static ByteString`	`INF` The byte string representation of infinity.
`static ByteString`	`NAN` The byte string representation of NaN.
`static ByteString`	`NIL` The byte string representation of nil.
`static ByteString`	`TRUE` The byte string representation of true.
`static ByteString`	`TYPENAME_BOOLEAN` Byte string representation of the Lua `boolean` type.
`static ByteString`	`TYPENAME_FUNCTION` Byte string representation of the Lua `function` type.
`static ByteString`	`TYPENAME_NIL` Byte string representation of the Lua `nil` type.
`static ByteString`	`TYPENAME_NUMBER` Byte string representation of the Lua `number` type.
`static ByteString`	`TYPENAME_STRING` Byte string representation of the Lua `string` type.
`static ByteString`	`TYPENAME_TABLE` Byte string representation of the Lua `table` type.
`static ByteString`	`TYPENAME_THREAD` Byte string representation of the Lua `thread` type.
`static ByteString`	`TYPENAME_USERDATA` Byte string representation of the Lua `userdata` type.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`escape(ByteString byteString)` Returns a string `esc` formed from the byte string `s` such that when `esc` is read by a Lua lexer as a string literal, it evaluates to a byte string equal to `s`.
`static String`	`escape(CharSequence s)` Returns a string `esc` formed from the character sequence `s` such that when `esc` is read by a Lua lexer as a string literal, it evaluates to a string equal to `s`.
`static boolean`	`isKeyword(String s)` Returns `true` iff the string `s` is a keyword in Lua.
`static boolean`	`isValidName(String s)` Returns `true` iff the string `s` is a valid Lua name.
`static double`	`parseFloat(String s)` Parses the string `s` as a float according to the Lua lexer rules.
`static long`	`parseInteger(String s)` Parses the string `s` as an integer according to the Lua lexer rules.
`static ByteString`	`toByteString(boolean b)` Returns the Lua format byte string representation of the boolean value `b` as a byte string.
`static ByteString`	`toByteString(double f)` Returns the Lua format byte string representation of the float value `f`.
`static ByteString`	`toByteString(long l)` Returns the Lua format byte string representation of the integer value `l`.
`static String`	`toString(boolean b)` Returns the Lua format string representation of the boolean value `b`.
`static String`	`toString(double f)` Returns the Lua format string representation of the float value `f`.
`static String`	`toString(long l)` Returns the Lua format string representation of the integer value `l`.
`static Double`	`tryParseFloat(String s)` Parses `s` as a float following the Lua lexer rules.
`static Long`	`tryParseInteger(String s)` Parses `s` as an integer following the Lua lexer rules.
`static Number`	`tryParseNumeral(String s)` Parses `s` as a number following the Lua lexer rules.

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

- Field Detail
  - NIL
```
public static final ByteString NIL
```
    The byte string representation of nil.
  - TRUE
```
public static final ByteString TRUE
```
    The byte string representation of true.
  - FALSE
```
public static final ByteString FALSE
```
    The byte string representation of false.
  - INF
```
public static final ByteString INF
```
    The byte string representation of infinity.
  - NAN
```
public static final ByteString NAN
```
    The byte string representation of NaN.
  - TYPENAME_NIL
```
public static final ByteString TYPENAME_NIL
```
    Byte string representation of the Lua nil type.
  - TYPENAME_BOOLEAN
```
public static final ByteString TYPENAME_BOOLEAN
```
    Byte string representation of the Lua boolean type.
  - TYPENAME_NUMBER
```
public static final ByteString TYPENAME_NUMBER
```
    Byte string representation of the Lua number type.
  - TYPENAME_STRING
```
public static final ByteString TYPENAME_STRING
```
    Byte string representation of the Lua string type.
  - TYPENAME_TABLE
```
public static final ByteString TYPENAME_TABLE
```
    Byte string representation of the Lua table type.
  - TYPENAME_FUNCTION
```
public static final ByteString TYPENAME_FUNCTION
```
    Byte string representation of the Lua function type.
  - TYPENAME_USERDATA
```
public static final ByteString TYPENAME_USERDATA
```
    Byte string representation of the Lua userdata type.
  - TYPENAME_THREAD
```
public static final ByteString TYPENAME_THREAD
```
    Byte string representation of the Lua thread type.
  - CHAR_BELL
```
public static final char CHAR_BELL
```
    The '\a' character.
    
    See Also:
    
    Constant Field Values
  - CHAR_VERTICAL_TAB
```
public static final char CHAR_VERTICAL_TAB
```
    The '\v' character.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - toString
```
public static String toString(boolean b)
```
    Returns the Lua format string representation of the boolean value b.
    Note: this method returns a java.lang.String. In order to obtain a byte string, use toByteString(boolean) rather than wrapping the result of this method using ByteString.of(String).
    
    Parameters:
    
    b - the boolean value
    
    Returns:
    
    string representation of b
  - toByteString
```
public static ByteString toByteString(boolean b)
```
    Returns the Lua format byte string representation of the boolean value b as a byte string.
    
    Parameters:
    
    b - the boolean value
    
    Returns:
    
    byte string representation of b
  - toString
```
public static String toString(long l)
```
    Returns the Lua format string representation of the integer value l.
    Note: this method returns a java.lang.String. In order to obtain a byte string, use toByteString(long) rather than wrapping the result of this method using ByteString.of(String).
    
    Parameters:
    
    l - the integer value
    
    Returns:
    
    string representation of l
  - toByteString
```
public static ByteString toByteString(long l)
```
    Returns the Lua format byte string representation of the integer value l.
    
    Parameters:
    
    l - the integer value
    
    Returns:
    
    byte string representation of l
  - toString
```
public static String toString(double f)
```
    Returns the Lua format string representation of the float value f.
    Note: this method returns a java.lang.String. In order to obtain a byte string, use toByteString(long) rather than wrapping the result of this method using ByteString.of(String).
    
    Parameters:
    
    f - the float value
    
    Returns:
    
    string representation of f
  - toByteString
```
public static ByteString toByteString(double f)
```
    Returns the Lua format byte string representation of the float value f.
    
    Parameters:
    
    f - the float value
    
    Returns:
    
    byte string representation of f
  - parseInteger
```
public static long parseInteger(String s)
                         throws NumberFormatException
```
    Parses the string s as an integer according to the Lua lexer rules. When s is not an integer numeral, throws a NumberFormatException.
    This method ignores leading and trailing whitespace in s.
    
    Parameters:
    
    s - string to be parsed, must not be null
    
    Returns:
    
    the integer value represented by s
    
    Throws:
    
    NullPointerException - if s is null
    
    NumberFormatException - if s is not a valid Lua format string representing an integer value
  - parseFloat
```
public static double parseFloat(String s)
                         throws NumberFormatException
```
    Parses the string s as a float according to the Lua lexer rules. When s is not a float numeral, throws a NumberFormatException.
    This method ignores leading and trailing whitespace in s.
    
    Parameters:
    
    s - the string to be parsed, must not be null
    
    Returns:
    
    the float value represented by s
    
    Throws:
    
    NullPointerException - if s is null
    
    NumberFormatException - if s is not a valid Lua format string representing a float value
  - tryParseInteger
```
public static Long tryParseInteger(String s)
```
    Parses s as an integer following the Lua lexer rules. When s is an integer numeral, returns its value boxed as a Long. Otherwise, returns null.
    This is a variant of parseInteger(String) that signals invalid input by returning null rather than throwing a NumberFormatException.
    
    Parameters:
    
    s - the string to be parsed, must not be null
    
    Returns:
    
    the (boxed) integer value represented by s if s is an integer numeral; null otherwise
    
    Throws:
    
    NullPointerException - if s is null
  - tryParseFloat
```
public static Double tryParseFloat(String s)
```
    Parses s as a float following the Lua lexer rules. When s is a float numeral, returns its value boxed as a Double. Otherwise, returns null.
    This is a variant of parseFloat(String) that signals invalid input by returning null rather than throwing a NumberFormatException.
    
    Parameters:
    
    s - the string to be parsed, must not be null
    
    Returns:
    
    the (boxed) float value represented by s if s is an float numeral; null otherwise
    
    Throws:
    
    NullPointerException - if s is null
  - tryParseNumeral
```
public static Number tryParseNumeral(String s)
```
    Parses s as a number following the Lua lexer rules. When s is a numeral, returns its value boxed either as a Long (for integer numerals) or a Double (for float numerals). Otherwise, returns null.
    Note an integer numeral is also a float numeral, but not all float numerals are integer numerals. This method returns the "most canonical" representation of the numeric value represented by s: it first tries to parse s as an integer, attempting to parse s as a float only when s is not an integer numeral.
    
    Parameters:
    
    s - the string to be parsed, must not be null
    
    Returns:
    
    the numeric value represented by s, or null if s is not a numeral
  - escape
```
public static String escape(CharSequence s)
```
    Returns a string esc formed from the character sequence s such that when esc is read by a Lua lexer as a string literal, it evaluates to a string equal to s. The resulting string is enclosed in double quotes (").
    
    Parameters:
    
    s - the character sequence to escape, must not be null
    
    Returns:
    
    a Lua string literal representing s
    
    Throws:
    
    NullPointerException - if s is null
  - escape
```
public static String escape(ByteString byteString)
```
    Returns a string esc formed from the byte string s such that when esc is read by a Lua lexer as a string literal, it evaluates to a byte string equal to s. The resulting string is enclosed in double quotes (").
    
    Parameters:
    
    byteString - the byte sequence sequence to escape, must not be null
    
    Returns:
    
    a Lua string literal representing s
    
    Throws:
    
    NullPointerException - if s is null
  - isKeyword
```
public static boolean isKeyword(String s)
```
    Returns true iff the string s is a keyword in Lua.
    A keyword in Lua is one of the following strings: "and", "break", "do", "else", "elseif", "end", "false", "for", "function", "goto", "if", "in", "local", "nil", "not", "or", "repeat", "return", "then", "true", "until", "while".
    
    Parameters:
    
    s - the string to be examined, may be null
    
    Returns:
    
    true if s is a Lua keyword; false otherwise
  - isValidName
```
public static boolean isValidName(String s)
```
    Returns true iff the string s is a valid Lua name.
    According to §3.1 of the Lua Reference Manual,
    
    Names (also called identifiers) in Lua can be any string of letters, digits, and underscores, not beginning with a digit and not being a reserved word.
    
    This implementation treats letters as characters in the ranges 'a'...'z' and 'A'...'Z', and numbers as characters in the range '0'...'9'.
    
    Parameters:
    
    s - the string to be checked for being a valid name, may be null
    
    Returns:
    
    true if s is a valid name in Lua; false otherwise

Class LuaFormat

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NIL

TRUE

FALSE

INF

NAN

TYPENAME_NIL

TYPENAME_BOOLEAN

TYPENAME_NUMBER

TYPENAME_STRING

TYPENAME_TABLE

TYPENAME_FUNCTION

TYPENAME_USERDATA

TYPENAME_THREAD

CHAR_BELL

CHAR_VERTICAL_TAB

Method Detail

toString

toByteString

toString

toByteString

toString

toByteString

parseInteger

parseFloat

tryParseInteger

tryParseFloat

tryParseNumeral

escape

escape

isKeyword

isValidName