---
# Contents
[TOC]
---
# String Manipulation
Global table variable: `string`
---
## Description
The following methods have been added to the built-in Lua
[`string` table](https://www.lua.org/manual/5.3/manual.html#6.4).
---
# Methods
---
## string.builder
string.builder ()
string.builder (st)
- Creates a [StringBuilder][java.lang.StringBuilder].
- Parameters:
- st: _([string][LuaString])_ String to append on instantiation.
- Returns: _([StringBuilder][java.lang.StringBuilder])_ New `StringBuilder` instance.
---
## string.endsWith
string.endsWith (st, suffix)
- Checks if a string ends with a set of characters.
- Parameters:
- st: _([string][LuaString])_ The string to be checked.
- suffix: _([string][LuaString])_ The suffix to be compared with.
- Returns: _([bool][LuaBoolean])_ `true` if ___suffix___ matches the end characters of ___st___.
- Aliases:
- string.endswith
---
## string.isNumber
string.isNumber (st)
- Checks if a string contains numeric characters only.
- Parameters:
- st: _([string][LuaString])_ The string to be checked.
- Returns: _([bool][LuaBoolean])_ `true` if all characters are numeric, `false` otherwise.
- Aliases:
- string.isnumber
- string.isNumeric
- string.isnumeric
---
## string.ltrim
string.ltrim (st)
- Removes leading whitespace from a string.
- Parameters:
- st: _([string][LuaString])_ The string to be trimmed.
- Returns: _([string][LuaString])_ Trimmed string.
---
## string.rtrim
string.rtrim (st)
- Removes trailing whitespace from a string.
- Parameters:
- st: _([string][LuaString])_ The string to be trimmed.
- Returns: _([string][LuaString])_ Trimmed string.
---
## string.split
string.split (str, delim)
- Splits a string into a table.
- Parameters:
- str: _([string][LuaString])_ The string to be split.
- delim: _([string][LuaString])_ The delimiter character(s) used to
split the string.
- Returns: _([table][LuaTable])_ List of strings.
---
## string.startsWith
string.startsWith (st, prefix)
- Checks if a string begins with a set of characters.
- Parameters:
- st: _([string][LuaString])_ The string to be checked.
- prefix: _([string][LuaString])_ The prefix to be compared with.
- Returns: _([bool][LuaBoolean])_ `true` if ___prefix___ matches the beginning characters of
___st___.
- Aliases:
- string.startswith
- string.beginsWith
- string.beginswith
---
## string.trim
string.trim (st)
- Removes leading & trailing whitespace from a string.
- Parameters:
- st: _([string][LuaString])_ The string to be trimmed.
- Returns: _([string][LuaString])_ Trimmed string.
---
## string.valueOf
string.valueOf (obj)
- Retrieves string value of an object.
- Parameters:
- obj: _([Object][java.lang.Object])_ Object instance to be
converted.
- Returns: _([string][LuaString])_ String value of object.
- Aliases:
- string.valueof
[java.lang.StringBuilder]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/StringBuilder.html
[java.lang.Object]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html
[LuaBoolean]: http://luaj.org/luaj/3.0/api/org/luaj/vm2/LuaBoolean.html
[LuaString]: http://luaj.org/luaj/3.0/api/org/luaj/vm2/LuaString.html
[LuaTable]: http://luaj.org/luaj/3.0/api/org/luaj/vm2/LuaTable.html