Package com.tameif.tame.element

Class TObject

java.lang.Object

com.tameif.tame.element.TElement

com.tameif.tame.element.TObject

All Implemented Interfaces:

Saveable

public class TObject
extends TElement

Objects are common elements that players interact with, examine, talk to, eat, take - you get the idea. Objects can also be added to the inventory of players. Objects in the possession of players take precedence over objects in a room.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field and Description
protected com.tameif.tame.struct.CaseInsensitiveStringSet	determiners Element's determiners (name token affixes).
protected com.tameif.tame.struct.CaseInsensitiveStringSet	names Element's names.
protected com.tameif.tame.struct.CaseInsensitiveStringSet	tags Element's names.

Constructor Summary

Constructors

Constructor and Description
TObject(java.lang.String identity) Creates an empty object.
TObject(java.lang.String identity, TObject parent) Creates an empty object.

Method Summary

Modifier and Type	Method and Description
void	addDeterminer(java.lang.String determiner) Adds a name determiner to this object.
void	addName(java.lang.String name) Adds an initial name to this object.
void	addTag(java.lang.String tag) Adds an initial tag to this object.
static TObject	create(java.io.InputStream in) Creates this object from an input stream, expecting its byte representation.
java.lang.Iterable<java.lang.String>	getDeterminers() Gets the name determiners on this object as an iterable structure.
java.lang.Iterable<java.lang.String>	getNames() Gets the initial names on this object as an iterable structure.
java.lang.Iterable<java.lang.String>	getTags() Gets the initial tags on this object as an iterable structure.
boolean	isValidEntryType(BlockEntryType type) Checks if this element handles a particular entry type.
void	readBytes(java.io.InputStream in) Imports this object from bytes.
void	writeBytes(java.io.OutputStream out) Exports this object to bytes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.tameif.tame.element.TElement

addBlock, addFunction, equals, equals, fromBytes, getBlock, getBlockEntries, getFunction, getFunctionEntries, getIdentity, getParent, hashCode, isArchetype, resolveBlock, resolveFunction, setArchetype, setIdentity, setIdentityForced, setParent, toBytes, toString

Field Detail

determiners

protected com.tameif.tame.struct.CaseInsensitiveStringSet determiners

Element's determiners (name token affixes).

names

protected com.tameif.tame.struct.CaseInsensitiveStringSet names

Element's names.

tags

protected com.tameif.tame.struct.CaseInsensitiveStringSet tags

Element's names.

Constructor Detail

TObject

public TObject(java.lang.String identity)

Creates an empty object.

Parameters:

identity - the unique identity.

TObject

public TObject(java.lang.String identity,
               TObject parent)

Creates an empty object.

Parameters:

identity - the unique identity.

parent - the object's parent object.

Method Detail

isValidEntryType

public final boolean isValidEntryType(BlockEntryType type)

Description copied from class: TElement

Checks if this element handles a particular entry type.

Specified by:

isValidEntryType in class TElement

Parameters:

type - the entry type to check.

Returns:

true if so, false if not.

addName

public void addName(java.lang.String name)

Adds an initial name to this object. These names are found by the interpreter.

Parameters:

name - the name to add.

getNames

public java.lang.Iterable<java.lang.String> getNames()

Gets the initial names on this object as an iterable structure.

Returns:

the case-insensitive hash containing the names.

addDeterminer

public void addDeterminer(java.lang.String determiner)

Adds a name determiner to this object. These are prepended to names when they are added/removed in contexts.

Parameters:

determiner - the name to add.

getDeterminers

public java.lang.Iterable<java.lang.String> getDeterminers()

Gets the name determiners on this object as an iterable structure.

Returns:

the case-insensitive hash containing the determiners.

addTag

public void addTag(java.lang.String tag)

Adds an initial tag to this object. These tags are used by some functions for doing stuff to objects.

Parameters:

tag - the tag to add.

getTags

public java.lang.Iterable<java.lang.String> getTags()

Gets the initial tags on this object as an iterable structure.

Returns:

an iterable object for iteration.

create

public static TObject create(java.io.InputStream in)
                      throws java.io.IOException

Creates this object from an input stream, expecting its byte representation.

Parameters:

in - the input stream to read from.

Returns:

the read object.

Throws:

java.io.IOException - if a read error occurs.

writeBytes

public void writeBytes(java.io.OutputStream out)
                throws java.io.IOException

Description copied from interface: Saveable

Exports this object to bytes.

Specified by:

writeBytes in interface Saveable

Overrides:

writeBytes in class TElement

Parameters:

out - the output stream to write to.

Throws:

java.io.IOException - if a write problem occurs.

readBytes

public void readBytes(java.io.InputStream in)
               throws java.io.IOException

Description copied from interface: Saveable

Imports this object from bytes.

Specified by:

readBytes in interface Saveable

Overrides:

readBytes in class TElement

Parameters:

in - the input stream to read from.

Throws:

java.io.IOException - if a read problem occurs.