li.cil.oc.api.network

Interface Arguments

All Superinterfaces:

java.lang.Iterable<java.lang.Object>

public interface Arguments
extends java.lang.Iterable<java.lang.Object>

This interface provides access to arguments passed to a Callback.

It allows checking for the presence of arguments in a uniform manner, taking care of proper type checking based on what can be passed along by Lua.

Note that integer values fetched this way are actually double values that have been truncated. So if a Lua program passes 1.9 and you do a checkInteger you'll get a 1.

The indexes passed to the various functions start at zero, i.e. to get the first argument you would use checkAny(0). This is worth mentioning because Lua starts its indexes at one.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	checkAny(int index) Get whatever is at the specified index.
boolean	checkBoolean(int index) Try to get a boolean value at the specified index.
byte[]	checkByteArray(int index) Try to get a byte array at the specified index.
double	checkDouble(int index) Try to get a double value at the specified index.
int	checkInteger(int index) Try to get an integer value at the specified index.
java.lang.String	checkString(int index) Try to get a string value at the specified index.
java.util.Map	checkTable(int index) Try to get a table at the specified index.
int	count() The total number of arguments that were passed to the function.
boolean	isBoolean(int index) Tests whether the argument at the specified index is a boolean value.
boolean	isByteArray(int index) Tests whether the argument at the specified index is a byte array.
boolean	isDouble(int index) Tests whether the argument at the specified index is a double value.
boolean	isInteger(int index) Tests whether the argument at the specified index is an integer value.
boolean	isString(int index) Tests whether the argument at the specified index is a string value.
boolean	isTable(int index) Tests whether the argument at the specified index is a table.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

count

int count()

The total number of arguments that were passed to the function.

checkAny

java.lang.Object checkAny(int index)

Get whatever is at the specified index.

Throws an error if there are too few arguments.

The returned object will be one of the following, based on the conversion performed internally:

• null if the Lua value was nil.
• java.lang.Boolean if the Lua value was a boolean.
• java.lang.Double if the Lua value was a number.
• byte[] if the Lua value was a string.

Parameters:

index - the index from which to get the argument.

Returns:

the raw value at that index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index.

checkBoolean

boolean checkBoolean(int index)

Try to get a boolean value at the specified index.

Throws an error if there are too few arguments.

Parameters:

index - the index from which to get the argument.

Returns:

the boolean value at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a boolean.

checkInteger

int checkInteger(int index)

Try to get an integer value at the specified index.

Throws an error if there are too few arguments.

Parameters:

index - the index from which to get the argument.

Returns:

the integer value at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a number.

checkDouble

double checkDouble(int index)

Try to get a double value at the specified index.

Throws an error if there are too few arguments.

Parameters:

index - the index from which to get the argument.

Returns:

the double value at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a number.

checkString

java.lang.String checkString(int index)

Try to get a string value at the specified index.

Throws an error if there are too few arguments.

This will actually check for a byte array and convert it to a string using UTF-8 encoding.

Parameters:

index - the index from which to get the argument.

Returns:

the boolean value at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a string.

checkByteArray

byte[] checkByteArray(int index)

Try to get a byte array at the specified index.

Throws an error if there are too few arguments.

Parameters:

index - the index from which to get the argument.

Returns:

the byte array at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a byte array.

checkTable

java.util.Map checkTable(int index)

Try to get a table at the specified index.

Throws an error if there are too few arguments.

Parameters:

index - the index from which to get the argument.

Returns:

the table at the specified index.

Throws:

java.lang.IllegalArgumentException - if there is no argument at that index, or if the argument is not a table.

isBoolean

boolean isBoolean(int index)

Tests whether the argument at the specified index is a boolean value.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is a boolean; false otherwise.

isInteger

boolean isInteger(int index)

Tests whether the argument at the specified index is an integer value.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is an integer; false otherwise.

isDouble

boolean isDouble(int index)

Tests whether the argument at the specified index is a double value.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is a double; false otherwise.

isString

boolean isString(int index)

Tests whether the argument at the specified index is a string value.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is a string; false otherwise.

isByteArray

boolean isByteArray(int index)

Tests whether the argument at the specified index is a byte array.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is a byte array; false otherwise.

isTable

boolean isTable(int index)

Tests whether the argument at the specified index is a table.

This will return false if there is no argument at the specified index, i.e. if there are too few arguments.

Parameters:

index - the index to check.

Returns:

true if the argument is a string; false otherwise.