org.starhope.appius.game.inventory
Class RarityRating

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

All Implemented Interfaces:

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

public class RarityRating
extends SimpleDataRecord<RarityRating>

WRITEME: Document this type.

Author:

twheys@gmail.com, brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private String	description WRITEME: Document this brpocock@star-hope.org
private int	id WRITEME: Document this brpocock@star-hope.org
private static long	serialVersionUID WRITEME: Document this brpocock@star-hope.org
private String	value WRITEME

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

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

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

RarityRating(RecordLoader<RarityRating> 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	getDescription()
int	getID()
String	getString() Deprecated. getValue()
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
String	getValue()
void	setDescription(String newDescription)
void	setID(int newID)
void	setValue(String newValue)

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

WRITEME: Document this brpocock@star-hope.org

See Also:

Constant Field Values

description

private String description

WRITEME: Document this brpocock@star-hope.org

id

private int id

WRITEME: Document this brpocock@star-hope.org

value

private String value

WRITEME

Constructor Detail

RarityRating

public RarityRating()

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

RarityRating

public RarityRating(RecordLoader<RarityRating> loader)

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

Parameters:

loader - loader

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()

getDescription

public String getDescription()

Returns:

the description

getID

public int getID()

Returns:

the id

getString

@Deprecated
public String getString()

Deprecated. getValue()

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

Returns:

getValue()

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()

getValue

public String getValue()

Returns:

the value

setDescription

public void setDescription(String newDescription)

Parameters:

newDescription - the description to set

setID

public void setID(int newID)

Parameters:

newID - the id to set

setValue

public void setValue(String newValue)

Parameters:

newValue - the value to set