org.starhope.appius.game.npc
Class ConversationState

java.lang.Object
  extended by org.starhope.appius.util.SimpleDataRecord<ConversationState>
      extended by org.starhope.appius.game.npc.ConversationState
All Implemented Interfaces:
com.whirlycott.cache.Cacheable, Serializable, Comparable<ConversationState>, CTime, DataRecord, HasSubversionRevision

public class ConversationState
extends SimpleDataRecord<ConversationState>

WRITEME: Document this type.

Author:
brpocock@star-hope.org
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.starhope.appius.util.SimpleDataRecord
myLoader, timeLastChanged, timeLastSaved
 
Constructor Summary
ConversationState(ConversationVerb verb, ConversationState nextState)
          WRITEME: Document this constructor brpocock@star-hope.org
ConversationState(String phrase, ConversationState nextState)
          WRITEME: Document this constructor brpocock@star-hope.org
 
Method Summary
 void add(ConversationStateType chooseRandom, ConversationState state)
          WRITEME: Document this method brpocock@star-hope.org
 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 getSubversionRevision()
           Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
 void setDelay(long duration)
          WRITEME: Document this method brpocock@star-hope.org
 
Methods inherited from class org.starhope.appius.util.SimpleDataRecord
changed, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsLoaded, markAsSaved, onRemove, onRetrieve, onStore, setRecordLoader, toString
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConversationState

public ConversationState(ConversationVerb verb,
                         ConversationState nextState)
WRITEME: Document this constructor brpocock@star-hope.org

Parameters:
verb - WRITEME
nextState - WRITEME

ConversationState

public ConversationState(String phrase,
                         ConversationState nextState)
WRITEME: Document this constructor brpocock@star-hope.org

Parameters:
phrase - WRITEME
nextState - WRITEME
Method Detail

add

public void add(ConversationStateType chooseRandom,
                ConversationState state)
WRITEME: Document this method brpocock@star-hope.org

Parameters:
chooseRandom - WRITEME
state - WRITEME

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

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: $"

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

Returns:
The Subversion revision level for this class's source code file.
See Also:
HasSubversionRevision.getSubversionRevision()

setDelay

public void setDelay(long duration)
WRITEME: Document this method brpocock@star-hope.org

Parameters:
duration - WRITEME