Enum StreamingIOFunctions

java.lang.Object

java.lang.Enum<StreamingIOFunctions>

com.blackrook.rookscript.functions.io.StreamingIOFunctions

All Implemented Interfaces:

ScriptFunctionType, Serializable, Comparable<StreamingIOFunctions>

public enum StreamingIOFunctions
extends Enum<StreamingIOFunctions>
implements ScriptFunctionType

Script common functions for data streaming.

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface ScriptFunctionType

ScriptFunctionType.Usage

Enum Constant Summary

Enum Constants

Enum Constant	Description
BISOPEN
BOSOPEN
CSITERATE
CSREAD
CSREADLN
CSROPEN
CSWOPEN
CSWRITE
CSWRITELN
FISOPEN
FLUSH
FOSOPEN
READ
RELAY
SKIP
SROPEN
STDERR
STDIN
STDOUT
SWOPEN
WRITE

Method Summary

Modifier and Type	Method	Description
static final ScriptFunctionResolver	createResolver()
abstract boolean	execute(ScriptInstance scriptInstance, ScriptValue returnValue)	Executes this function.
int	getParameterCount()
ScriptFunctionType.Usage	getUsage()
protected abstract ScriptFunctionType.Usage	usage()
static StreamingIOFunctions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StreamingIOFunctions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ScriptFunctionType

name

Enum Constant Details

SKIP

public static final StreamingIOFunctions SKIP

Since:

1.7.0, accepts InputStreams.

FLUSH

public static final StreamingIOFunctions FLUSH

RELAY

public static final StreamingIOFunctions RELAY

READ

public static final StreamingIOFunctions READ

WRITE

public static final StreamingIOFunctions WRITE

STDIN

public static final StreamingIOFunctions STDIN

STDOUT

public static final StreamingIOFunctions STDOUT

STDERR

public static final StreamingIOFunctions STDERR

FISOPEN

public static final StreamingIOFunctions FISOPEN

FOSOPEN

public static final StreamingIOFunctions FOSOPEN

BISOPEN

public static final StreamingIOFunctions BISOPEN

BOSOPEN

public static final StreamingIOFunctions BOSOPEN

CSROPEN

public static final StreamingIOFunctions CSROPEN

CSWOPEN

public static final StreamingIOFunctions CSWOPEN

SROPEN

public static final StreamingIOFunctions SROPEN

Since:

1.5.0

SWOPEN

public static final StreamingIOFunctions SWOPEN

Since:

1.5.0

CSREAD

public static final StreamingIOFunctions CSREAD

CSREADLN

public static final StreamingIOFunctions CSREADLN

CSITERATE

public static final StreamingIOFunctions CSITERATE

CSWRITE

public static final StreamingIOFunctions CSWRITE

CSWRITELN

public static final StreamingIOFunctions CSWRITELN

Method Details

values

public static StreamingIOFunctions[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StreamingIOFunctions 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

createResolver

public static final ScriptFunctionResolver createResolver()

Returns:

a function resolver that handles all of the functions in this enum.

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface ScriptFunctionType

Returns:

the total amount of parameters this takes.

getUsage

public ScriptFunctionType.Usage getUsage()

Specified by:

getUsage in interface ScriptFunctionType

Returns:

this function's usage instructions.

execute

public abstract boolean execute(ScriptInstance scriptInstance,
 ScriptValue returnValue)

Description copied from interface: ScriptFunctionType

Executes this function. The value in returnValue is automatically pushed onto the stack after the call. If a Throwable is thrown from this call, it is wrapped in a ScriptExecutionException. ScriptExecutionExceptions are thrown as-is.

Specified by:

execute in interface ScriptFunctionType

Parameters:

scriptInstance - the originating script instance.

returnValue - the value pushed to the stack on return.

Returns:

if false, this halts script execution, else if true, continue.

usage

protected abstract ScriptFunctionType.Usage usage()