Package com.tameif.tame.factory

Class TAMEScriptReader

java.lang.Object

com.tameif.tame.factory.TAMEScriptReader

All Implemented Interfaces:

TAMEConstants

public final class TAMEScriptReader
extends java.lang.Object
implements TAMEConstants

A TAMEScript reading class that produces scripts.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STREAMNAME_TEXT

Fields inherited from interface com.tameif.tame.TAMEConstants

CUE_ERROR, CUE_FATAL, CUE_PAUSE, CUE_QUIT, CUE_TEXT, CUE_TEXTF, CUE_TRACE, CUE_WAIT, DEFAULT_FUNCTION_DEPTH, DEFAULT_RUNAWAY_THRESHOLD, HEADER_AUTHOR, HEADER_COUNTRY, HEADER_EMAIL, HEADER_LANGUAGE, HEADER_TAME_FUNCDEPTH_MAX, HEADER_TAME_RUNAWAY_MAX, HEADER_TITLE, HEADER_TWITTER, HEADER_VERSION, HEADER_WEBSITE, IDENTITY_ARCHETYPE_CONTAINER, IDENTITY_CURRENT_PLAYER, IDENTITY_CURRENT_ROOM, IDENTITY_CURRENT_WORLD, RETURN_VARIABLE

Method Summary

Modifier and Type	Method and Description
static TAMEModule	read(java.io.File file) Reads TAMEModule objects into a new module from a starting text file.
static TAMEModule	read(java.io.File file, TAMEScriptIncluder includer) Reads TAMEModule objects into a new module from a starting text file.
static TAMEModule	read(java.io.File file, TAMEScriptReaderOptions options) Reads TAMEModule objects into a new module from a starting text file.
static TAMEModule	read(java.io.File file, TAMEScriptReaderOptions options, TAMEScriptIncluder includer) Reads TAMEModule objects into a new module from a starting text file.
static TAMEModule	read(java.lang.String text) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String text, TAMEScriptIncluder includer) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String text, TAMEScriptReaderOptions options) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String text, TAMEScriptReaderOptions options, TAMEScriptIncluder includer) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String streamName, java.io.InputStream in) Reads TAMEModule objects into a new module.
static TAMEModule	read(java.lang.String streamName, java.io.InputStream in, TAMEScriptIncluder includer) Reads TAMEModule objects into a new module.
static TAMEModule	read(java.lang.String streamName, java.io.InputStream in, TAMEScriptReaderOptions options) Reads TAMEModule objects into a new module.
static TAMEModule	read(java.lang.String streamName, java.io.InputStream in, TAMEScriptReaderOptions options, TAMEScriptIncluder includer) Reads TAMEModule objects into a new module.
static TAMEModule	read(java.lang.String streamName, java.lang.String text) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String streamName, java.lang.String text, TAMEScriptIncluder includer) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String streamName, java.lang.String text, TAMEScriptReaderOptions options) Reads TAMEModule objects from a String of text into a new module.
static TAMEModule	read(java.lang.String streamName, java.lang.String text, TAMEScriptReaderOptions options, TAMEScriptIncluder includer) Reads TAMEModule objects from a String of text into a new module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STREAMNAME_TEXT

public static final java.lang.String STREAMNAME_TEXT

See Also:

Constant Field Values

Method Detail

read

public static TAMEModule read(java.lang.String text)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

text - the String to read from.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String text,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

text - the String to read from.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if text is null.

read

public static TAMEModule read(java.lang.String text,
                              TAMEScriptReaderOptions options)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

text - the String to read from.

options - the reader options for compiling.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String text,
                              TAMEScriptReaderOptions options,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

text - the String to read from.

options - the reader options for compiling.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.lang.String text)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

streamName - a name to assign to the stream.

text - the String to read from.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.lang.String text,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

streamName - a name to assign to the stream.

text - the String to read from.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if text is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.lang.String text,
                              TAMEScriptReaderOptions options)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

streamName - a name to assign to the stream.

text - the String to read from.

options - the reader options for compiling.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.lang.String text,
                              TAMEScriptReaderOptions options,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects from a String of text into a new module.

Parameters:

streamName - a name to assign to the stream.

text - the String to read from.

options - the reader options for compiling.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

java.io.IOException - if the stream can't be read.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.io.File file)
                       throws java.io.IOException

Reads TAMEModule objects into a new module from a starting text file.

Parameters:

file - the file to read from.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.io.File file,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects into a new module from a starting text file.

Parameters:

file - the file to read from.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.io.File file,
                              TAMEScriptReaderOptions options)
                       throws java.io.IOException

Reads TAMEModule objects into a new module from a starting text file.

Parameters:

file - the file to read from.

options - the reader options for compiling.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.io.File file,
                              TAMEScriptReaderOptions options,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects into a new module from a starting text file.

Parameters:

file - the file to read from.

options - the reader options for compiling.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if file is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.io.InputStream in)
                       throws java.io.IOException

Reads TAMEModule objects into a new module.

Parameters:

streamName - the name of the stream.

in - the stream to read from.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if in is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.io.InputStream in,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects into a new module.

Parameters:

streamName - the name of the stream.

in - the stream to read from.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if in is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.io.InputStream in,
                              TAMEScriptReaderOptions options)
                       throws java.io.IOException

Reads TAMEModule objects into a new module.

Parameters:

streamName - the name of the stream.

in - the stream to read from.

options - the reader options for compiling.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if in is null.

read

public static TAMEModule read(java.lang.String streamName,
                              java.io.InputStream in,
                              TAMEScriptReaderOptions options,
                              TAMEScriptIncluder includer)
                       throws java.io.IOException

Reads TAMEModule objects into a new module.

Parameters:

streamName - the name of the stream.

in - the stream to read from.

options - the reader options for compiling.

includer - the includer to use to resolve "included" paths.

Returns:

A new TAMEModule that contains all the read object hierarchy.

Throws:

TAMEScriptParseException - if one or more parse errors happen.

java.io.IOException - if the stream can't be read.

java.lang.SecurityException - if a read error happens due to OS permissioning.

java.lang.NullPointerException - if in is null.