org.starhope.appius.game
Class RoomLayer

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<RoomLayer>
      org.starhope.appius.game.RoomLayer

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<RoomLayer>, CTime, DataRecord, HasSubversionRevision

public class RoomLayer
extends SimpleDataRecord<RoomLayer>

WRITEME: Document this type.

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private String	filename WRITEME: Document this brpocock@star-hope.org
private String	identifier WRITEME: Document this brpocock@star-hope.org
private RoomLayerKind	kind WRITEME: Document this brpocock@star-hope.org
private Room	myRoom WRITEME
private static long	serialVersionUID Java Serialisation Unique ID
private double	stackingOrder WRITEME: Document this brpocock@star-hope.org

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

RoomLayer(RecordLoader<RoomLayer> loader)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

int	getCacheableID() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getCacheableIdent() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getFilename()
String	getIdentifier()
RoomLayerKind	getKind()
Room	getRoom()
double	getStackingOrder()
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
void	setFilename(String newFilename)
void	setIdentifier(String newIdentifier)
void	setKind(RoomLayerKind newKind)
void	setRoom(Room room)

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Java Serialisation Unique ID

See Also:

Constant Field Values

filename

private String filename

WRITEME: Document this brpocock@star-hope.org

identifier

private String identifier

WRITEME: Document this brpocock@star-hope.org

kind

private RoomLayerKind kind

WRITEME: Document this brpocock@star-hope.org

stackingOrder

private final double stackingOrder

WRITEME: Document this brpocock@star-hope.org

See Also:

Constant Field Values

myRoom

private Room myRoom

WRITEME

Constructor Detail

RoomLayer

public RoomLayer(RecordLoader<RoomLayer> loader)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

loader - WRITEME

Method Detail

getCacheableID

public int getCacheableID()
                   throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique ID number

Throws:

NotFoundException - if the item doesn't have a distinct numeric ID

See Also:

DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()
                         throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique identifier string

Throws:

NotFoundException - if the item doesn't have a distinct string identifier

See Also:

DataRecord.getCacheableIdent()

getFilename

public String getFilename()

Returns:

the filename

getIdentifier

public String getIdentifier()

Returns:

the identifier

getKind

public RoomLayerKind getKind()

Returns:

the kind

getRoom

public Room getRoom()

Returns:

the myRoom

getStackingOrder

public double getStackingOrder()

Returns:

the stackingOrder

getSubversionRevision

public String getSubversionRevision()

Description copied from interface: HasSubversionRevision

Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

As an example,the Subversion revision string for this file is "$Rev: 1968 $"

 
 @Override
 public String getSubversionRevision () {
        return "$Rev: ";
 }
 

Returns:

The Subversion revision level for this class's source code file.

See Also:

HasSubversionRevision.getSubversionRevision()

setFilename

public void setFilename(String newFilename)

Parameters:

newFilename - the filename to set

setIdentifier

public void setIdentifier(String newIdentifier)

Parameters:

newIdentifier - the identifier to set

setKind

public void setKind(RoomLayerKind newKind)

Parameters:

newKind - the kind to set

setRoom

public void setRoom(Room room)

Parameters:

room - the myRoom to set