Package com.tameif.tame.lang

Class Cue

java.lang.Object

com.tameif.tame.lang.Cue

public class Cue
extends java.lang.Object

A cue is a piece of significant response sent back to the player on a single request-response loop. Many cues can be sent back at once, and it is up to the client how to process them.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	content The content.
protected java.lang.String	type Type of cue.

Method Summary

Modifier and Type	Method and Description
static Cue	create(java.lang.String type) Creates a new cue with no content.
static Cue	create(java.lang.String type, boolean content) Creates a new cue.
static Cue	create(java.lang.String type, double content) Creates a new cue.
static Cue	create(java.lang.String type, long content) Creates a new cue.
static Cue	create(java.lang.String type, java.lang.String content) Creates a new cue.
java.lang.String	getContent() Gets this message cue's content.
java.lang.String	getType() Gets this message cue's type.
boolean	isType(java.lang.String type) Checks if a cue is a specific type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

content

protected java.lang.String content

The content.

type

protected java.lang.String type

Type of cue.

Method Detail

create

public static Cue create(java.lang.String type)

Creates a new cue with no content.

Parameters:

type - the cue type.

Returns:

the created cue.

create

public static Cue create(java.lang.String type,
                         boolean content)

Creates a new cue.

Parameters:

type - the cue type.

content - the content.

Returns:

the created cue.

create

public static Cue create(java.lang.String type,
                         long content)

Creates a new cue.

Parameters:

type - the cue type.

content - the content.

Returns:

the created cue.

create

public static Cue create(java.lang.String type,
                         double content)

Creates a new cue.

Parameters:

type - the cue type.

content - the content.

Returns:

the created cue.

create

public static Cue create(java.lang.String type,
                         java.lang.String content)

Creates a new cue.

Parameters:

type - the cue type.

content - the content.

Returns:

the created cue.

getType

public java.lang.String getType()

Gets this message cue's type.

Returns:

the cue type.

isType

public boolean isType(java.lang.String type)

Checks if a cue is a specific type.

Parameters:

type - the cue type.

Returns:

true if match, false otherwise.

getContent

public java.lang.String getContent()

Gets this message cue's content.

Returns:

the cue content.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object