Package com.tameif.tame

Class TAMEResponse

java.lang.Object

com.tameif.tame.TAMEResponse

All Implemented Interfaces:

TAMEConstants

public class TAMEResponse
extends java.lang.Object
implements TAMEConstants

Response object generated by the engine in which error or output messages get sent back (and perhaps re-interpreted by the client or other objects to facilitate user feedback).

Author:

Matthew Tropiano

Field Summary

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
void	addCue(java.lang.String type) Adds a response cue to this response object with no content.
void	addCue(java.lang.String type, boolean content) Adds a response cue to this response object.
void	addCue(java.lang.String type, double content) Adds a response cue to this response object.
void	addCue(java.lang.String type, long content) Adds a response cue to this response object.
void	addCue(java.lang.String type, java.lang.String content) Adds a response cue to this response object.
java.util.Queue<Cue>	getCues() Returns the cues on this response.
long	getInterpretNanos() Gets the amount of nanos it took to process the input itself.
long	getOperationsExecuted()
long	getRequestNanos() Gets the request nanos for the full processing.
void	trace(TAMERequest request, TraceType type, java.lang.String format, java.lang.Object... args) Adds a trace cue, but only if a specific trace type is set on the request.

Methods inherited from class java.lang.Object

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

Method Detail

getCues

public java.util.Queue<Cue> getCues()

Returns the cues on this response.

Returns:

the queue of cues on the response.

addCue

public void addCue(java.lang.String type,
                   long content)

Adds a response cue to this response object. It can range from sound cues to changes in scenery, or additional instructions from the virtual machine to a client. The client is required to obey certain cues, and can safely ignore the rest.

Parameters:

type - the cue type name.

content - the cue content.

addCue

public void addCue(java.lang.String type,
                   double content)

Adds a response cue to this response object. It can range from sound cues to changes in scenery, or additional instructions from the virtual machine to a client. The client is required to obey certain cues, and can safely ignore the rest.

Parameters:

type - the cue type name.

content - the cue content.

addCue

public void addCue(java.lang.String type,
                   boolean content)

Adds a response cue to this response object. It can range from sound cues to changes in scenery, or additional instructions from the virtual machine to a client. The client is required to obey certain cues, and can safely ignore the rest.

Parameters:

type - the cue type name.

content - the cue content.

addCue

public void addCue(java.lang.String type,
                   java.lang.String content)

Adds a response cue to this response object. It can range from sound cues to changes in scenery, or additional instructions from the virtual machine to a client. The client is required to obey certain cues, and can safely ignore the rest.

Parameters:

type - the cue type name.

content - the cue content.

addCue

public void addCue(java.lang.String type)

Adds a response cue to this response object with no content. It can range from sound cues to changes in scenery, or additional instructions from the virtual machine to a client. The client is required to obey certain cues, and can safely ignore the rest.

Parameters:

type - the cue type name.

getOperationsExecuted

public long getOperationsExecuted()

Returns:

the amount of operations executed because of the input.

trace

public void trace(TAMERequest request,
                  TraceType type,
                  java.lang.String format,
                  java.lang.Object... args)

Adds a trace cue, but only if a specific trace type is set on the request.

Parameters:

request - the request to examine for the trace flag.

type - the trace type for this trace output.

format - the formatter string.

args - the formatter arguments.

See Also:

Formatter

getRequestNanos

public long getRequestNanos()

Gets the request nanos for the full processing.

Returns:

the time in nanoseconds for processing the request.

getInterpretNanos

public long getInterpretNanos()

Gets the amount of nanos it took to process the input itself.

Returns:

the time in nanoseconds to interpret client input.