Package com.tameif.tame.element.context

Class TElementContext<T extends TElement>

java.lang.Object

com.tameif.tame.element.context.TElementContext<T>

Type Parameters:

T - a TElement type.

All Implemented Interfaces:

StateSaveable

Direct Known Subclasses:

TContainerContext, TObjectContext, TPlayerContext, TRoomContext, TWorldContext

public abstract class TElementContext<T extends TElement>
extends java.lang.Object
implements StateSaveable

Holds contextual information for a TElement.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field and Description
protected T	element Reference to source element.
protected ValueSet	variables Variable bank.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TElementContext(T element) Creates an element context.

Method Summary

Modifier and Type	Method and Description
void	clearValue(java.lang.String variableName) Clears a variable's value on this context.
T	getElement() Gets the element associated with this context.
Value	getValue(java.lang.String variableName) Gets a variable's value on this context.
void	readStateBytes(TAMEModule module, java.util.Map<java.lang.Long,Value> referenceMap, java.io.InputStream in) Imports this object's state from bytes.
void	setValue(java.lang.String variableName, Value value) Sets a variable's value on this context.
java.lang.String	toString()
java.util.Iterator<java.lang.String>	values() Returns an iterator of this context's value names.
void	writeStateBytes(TAMEModule module, java.util.concurrent.atomic.AtomicLong referenceCounter, java.util.Map<java.lang.Object,java.lang.Long> referenceSet, java.io.OutputStream out) Exports this object's state to bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tameif.tame.lang.StateSaveable

fromStateBytes, toStateBytes

Field Detail

element

protected T extends TElement element

Reference to source element.

variables

protected ValueSet variables

Variable bank.

Constructor Detail

TElementContext

protected TElementContext(T element)

Creates an element context.

Parameters:

element - the element reference.

Method Detail

getElement

public T getElement()

Gets the element associated with this context.

Returns:

the element that this holds state for.

setValue

public void setValue(java.lang.String variableName,
                     Value value)

Sets a variable's value on this context.

Parameters:

variableName - the variable name.

value - the variable value.

getValue

public Value getValue(java.lang.String variableName)

Gets a variable's value on this context.

Parameters:

variableName - the variable name.

Returns:

the corresponding value, or a value that represents "false" if no value.

values

public java.util.Iterator<java.lang.String> values()

Returns an iterator of this context's value names.

Returns:

an iterator of each set value.

clearValue

public void clearValue(java.lang.String variableName)

Clears a variable's value on this context.

Parameters:

variableName - the variable name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeStateBytes

public void writeStateBytes(TAMEModule module,
                            java.util.concurrent.atomic.AtomicLong referenceCounter,
                            java.util.Map<java.lang.Object,java.lang.Long> referenceSet,
                            java.io.OutputStream out)
                     throws java.io.IOException

Description copied from interface: StateSaveable

Exports this object's state to bytes.

Specified by:

writeStateBytes in interface StateSaveable

Parameters:

module - the source module for reference.

referenceCounter - the reference counter to use for when unique values are seen.

referenceSet - the reference set to use for "seen" value references - maps object reference to counter value.

out - the output stream to write to.

Throws:

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

readStateBytes

public void readStateBytes(TAMEModule module,
                           java.util.Map<java.lang.Long,Value> referenceMap,
                           java.io.InputStream in)
                    throws java.io.IOException

Description copied from interface: StateSaveable

Imports this object's state from bytes.

Specified by:

readStateBytes in interface StateSaveable

Parameters:

module - the source module for reference.

referenceMap - the reference map to use for "seen" value references.

in - the input stream to read from.

Throws:

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