Package com.tameif.tame.element.context

Class TOwnershipMap

java.lang.Object

com.tameif.tame.element.context.TOwnershipMap

All Implemented Interfaces:

StateSaveable, TAMEConstants

public class TOwnershipMap
extends java.lang.Object
implements StateSaveable, TAMEConstants

An ownership map for all objects.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<TObject,com.tameif.tame.struct.CaseInsensitiveStringSet>	objectCurrentNames Map of object to its current names.
protected java.util.Map<TObject,com.tameif.tame.struct.CaseInsensitiveStringSet>	objectCurrentTags Map of object to its current tags.
protected com.tameif.tame.struct.HashDequeMap<ObjectContainer,TObject>	objectsOwnedByElements Ownership map - objects owned by elements.
protected java.util.Map<TObject,ObjectContainer>	objectsToElement Reverse lookup object - not saved.
protected java.util.Map<TPlayer,java.util.Deque<TRoom>>	playerToRoomStack Room stack.

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

Constructor Summary

Constructors

Constructor and Description
TOwnershipMap() Creates a new ownership.

Method Summary

Modifier and Type	Method and Description
void	addObjectName(TObject object, java.lang.String name) Adds a name to an object.
void	addObjectTag(TObject object, java.lang.String tag) Adds a tag to this object.
void	addObjectToElement(TObject object, ObjectContainer element) Adds an object to an element that can hold objects.
void	addPlayerToRoom(TPlayer player, TRoom room) Adds a player to a room and discards the stack.
boolean	checkElementHasObject(ObjectContainer element, TObject object) Checks if an element possesses an object.
boolean	checkObjectHasName(TObject object, java.lang.String name) Checks if an object contains a particular name.
boolean	checkObjectHasNoOwner(TObject object) Checks if an object has no owner.
boolean	checkObjectHasTag(TObject object, java.lang.String tag) Checks if an object contains a particular tag.
boolean	checkPlayerHasRoomInStack(TPlayer player, TRoom room) Returns if a player is in a room (or room is in stack).
TPlayer	getCurrentPlayer() Gets the current player by the current player id.
TRoom	getCurrentRoom() Gets the current room by the current room id.
TRoom	getCurrentRoom(TPlayer player) Returns the current room for a player.
java.lang.Iterable<TObject>	getObjectsOwnedByElement(ObjectContainer element) Gets the list of objects owned by an element.
int	getObjectsOwnedByElementCount(ObjectContainer element) Gets the count of objects owned by an element.
TRoom	popRoomFromPlayer(TPlayer player) Pops a room off of a player's room stack.
void	pushRoomOntoPlayer(TPlayer player, TRoom room) Pushes a room onto a player's room stack.
void	readStateBytes(TAMEModule module, java.util.Map<java.lang.Long,Value> referenceMap, java.io.InputStream in) Imports this object's state from bytes.
void	removeObject(TObject object) Removes an object from all owners.
void	removeObjectName(TObject object, java.lang.String name) Removes a name from an object.
void	removeObjectTag(TObject object, java.lang.String tag) Removes a tag from an object.
void	removePlayer(TPlayer player) Removes a player from all rooms.
void	reset() Clears entire ownership table.
void	setCurrentPlayer(TPlayer player) Sets the current player.
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, toString, wait, wait, wait

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

fromStateBytes, toStateBytes

Field Detail

objectCurrentNames

protected java.util.Map<TObject,com.tameif.tame.struct.CaseInsensitiveStringSet> objectCurrentNames

Map of object to its current names.

objectCurrentTags

protected java.util.Map<TObject,com.tameif.tame.struct.CaseInsensitiveStringSet> objectCurrentTags

Map of object to its current tags.

objectsOwnedByElements

protected com.tameif.tame.struct.HashDequeMap<ObjectContainer,TObject> objectsOwnedByElements

Ownership map - objects owned by elements.

objectsToElement

protected java.util.Map<TObject,ObjectContainer> objectsToElement

Reverse lookup object - not saved.

playerToRoomStack

protected java.util.Map<TPlayer,java.util.Deque<TRoom>> playerToRoomStack

Room stack.

Constructor Detail

TOwnershipMap

public TOwnershipMap()

Creates a new ownership.

Method Detail

reset

public void reset()

Clears entire ownership table.

removeObject

public void removeObject(TObject object)

Removes an object from all owners.

Parameters:

object - the object to remove.

removePlayer

public void removePlayer(TPlayer player)

Removes a player from all rooms.

Parameters:

player - the player to remove.

addObjectToElement

public void addObjectToElement(TObject object,
                               ObjectContainer element)

Adds an object to an element that can hold objects. The object is first removed from its owners before it is bound to another.

Parameters:

object - the object to add.

element - the target element.

addPlayerToRoom

public void addPlayerToRoom(TPlayer player,
                            TRoom room)

Adds a player to a room and discards the stack.

Parameters:

player - the player to add.

room - the target room.

pushRoomOntoPlayer

public void pushRoomOntoPlayer(TPlayer player,
                               TRoom room)

Pushes a room onto a player's room stack.

Parameters:

player - the player to change.

room - the room to push.

popRoomFromPlayer

public TRoom popRoomFromPlayer(TPlayer player)

Pops a room off of a player's room stack. The room is removed.

Parameters:

player - the player to change.

Returns:

the topmost removed room.

checkElementHasObject

public boolean checkElementHasObject(ObjectContainer element,
                                     TObject object)

Checks if an element possesses an object.

Parameters:

element - the element to use.

object - the object in question.

Returns:

true if so, false if not.

checkObjectHasNoOwner

public boolean checkObjectHasNoOwner(TObject object)

Checks if an object has no owner.

Parameters:

object - the object in question.

Returns:

true if so, false if not.

checkPlayerHasRoomInStack

public boolean checkPlayerHasRoomInStack(TPlayer player,
                                         TRoom room)

Returns if a player is in a room (or room is in stack).

Parameters:

player - the player to use.

room - the room to use.

Returns:

true if so, false if not.

setCurrentPlayer

public void setCurrentPlayer(TPlayer player)

Sets the current player.

Parameters:

player - the player to set as current player.

getCurrentPlayer

public TPlayer getCurrentPlayer()

Gets the current player by the current player id.

Returns:

the current player, or null if not set.

getCurrentRoom

public TRoom getCurrentRoom(TPlayer player)

Returns the current room for a player.

Parameters:

player - the player to use.

Returns:

the current room or null if no room.

getCurrentRoom

public TRoom getCurrentRoom()

Gets the current room by the current room id.

Returns:

the current room, or null if not set or current player is not set.

getObjectsOwnedByElement

public java.lang.Iterable<TObject> getObjectsOwnedByElement(ObjectContainer element)

Gets the list of objects owned by an element.

Parameters:

element - the element in question.

Returns:

the list of all objects owned by the element.

getObjectsOwnedByElementCount

public int getObjectsOwnedByElementCount(ObjectContainer element)

Gets the count of objects owned by an element.

Parameters:

element - the element in question.

Returns:

the amount of objects owned by the element.

addObjectName

public void addObjectName(TObject object,
                          java.lang.String name)

Adds a name to an object. This name is the one referred to in requests. The name is converted to lowercase and all contiguous whitespace is replaced with single spaces.

Parameters:

object - the object to use.

name - the name to add.

removeObjectName

public void removeObjectName(TObject object,
                             java.lang.String name)

Removes a name from an object. This name is the one referred to in requests. The name is converted to lowercase and all contiguous whitespace is replaced with single spaces.

Parameters:

object - the object to use.

name - the name to remove.

checkObjectHasName

public boolean checkObjectHasName(TObject object,
                                  java.lang.String name)

Checks if an object contains a particular name. This name is the one referred to in requests.

Parameters:

name - the name to check.

object - the object to use.

Returns:

true if so, false if not.

addObjectTag

public void addObjectTag(TObject object,
                         java.lang.String tag)

Adds a tag to this object. This is referred to in tag operations. Unlike names, tags do not undergo whitespace conversion.

Parameters:

object - the object to use.

tag - the tag to add.

removeObjectTag

public void removeObjectTag(TObject object,
                            java.lang.String tag)

Removes a tag from an object. This is referred to in tag operations. Unlike names, tags do not undergo whitespace conversion.

Parameters:

object - the object to use.

tag - the tag to remove.

checkObjectHasTag

public boolean checkObjectHasTag(TObject object,
                                 java.lang.String tag)

Checks if an object contains a particular tag. This is referred to in tag operations. Unlike names, tags do not undergo whitespace conversion.

Parameters:

object - the object to use.

tag - the tag to check.

Returns:

true if so, false if not.

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.