com.planet_ink.coffee_mud.Common
Class DefaultSession

java.lang.Object
  extended by java.lang.Thread
      extended by com.planet_ink.coffee_mud.Common.DefaultSession
All Implemented Interfaces:
CMCommon, Session, CMObject, Modifiable, java.lang.Cloneable, java.lang.Comparable<CMObject>, java.lang.Runnable

public class DefaultSession
extends java.lang.Thread
implements Session


Nested Class Summary
static class DefaultSession.LoginLogoutThread
           
 
Nested classes/interfaces inherited from class java.lang.Thread
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
 
Field Summary
protected  PlayerAccount acct
           
protected  boolean afkFlag
           
protected  java.lang.String afkMessage
           
protected  boolean bNextByteIs255
           
protected  boolean[] clientTelnetCodes
           
protected  java.lang.String[] clookup
           
protected  boolean connectionComplete
           
protected  java.lang.StringBuffer curPrevMsg
           
protected  int currentColor
           
protected  java.lang.StringBuffer fakeInput
           
protected  java.io.BufferedReader in
           
protected  java.lang.StringBuffer input
           
protected  boolean killFlag
           
protected  long lastBlahCheck
           
protected  int lastColor
           
protected  java.lang.String lastColorStr
           
protected  long lastKeystroke
           
protected  long lastLoopTop
           
protected  long lastNPCFight
           
protected  long lastPKFight
           
protected  long lastStart
           
protected  long lastStop
           
protected  java.lang.String lastStr
           
protected  boolean lastWasCR
           
protected  boolean lastWasLF
           
protected  long milliTotal
           
protected  MOB mob
           
protected  boolean needPrompt
           
protected  long onlineTime
           
protected  java.io.PrintWriter out
           
protected  java.lang.StringBuffer preliminaryInput
           
protected  java.util.List<java.lang.String> previousCmd
           
protected  java.util.List<java.lang.String> prevMsgs
           
protected  long promptLastShown
           
protected  java.io.OutputStream rawout
           
protected  boolean[] serverTelnetCodes
           
protected static int sessionCounter
           
protected  java.util.List snoops
           
protected  int snoopSuspensionStack
           
protected  java.net.Socket sock
           
protected static int SOTIMEOUT
           
protected  int spamStack
           
protected  int status
           
protected  boolean suspendCommandLine
           
protected  int terminalHeight
           
protected  java.lang.String terminalType
           
protected  int terminalWidth
           
protected  long tickTotal
           
protected  long userLoginTime
           
protected  boolean waiting
           
protected  java.util.concurrent.locks.ReentrantLock writeLock
           
protected  long writeStartTime
           
 
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Fields inherited from interface com.planet_ink.coffee_mud.Common.interfaces.Session
MAX_PREVMSGS, STATUS_ACCOUNTMENU, STATUS_LOGIN, STATUS_LOGIN1, STATUS_LOGIN2, STATUS_LOGOUT, STATUS_LOGOUT1, STATUS_LOGOUT10, STATUS_LOGOUT11, STATUS_LOGOUT12, STATUS_LOGOUT2, STATUS_LOGOUT3, STATUS_LOGOUT4, STATUS_LOGOUT5, STATUS_LOGOUT6, STATUS_LOGOUT7, STATUS_LOGOUT8, STATUS_LOGOUT9, STATUS_LOGOUTFINAL, STATUS_OK, STATUS_STR, TELNET_ANSI, TELNET_AYT, TELNET_BINARY, TELNET_COMPRESS, TELNET_COMPRESS2, TELNET_DESCS, TELNET_DO, TELNET_DONT, TELNET_EC, TELNET_ECHO, TELNET_IAC, TELNET_LINEMODE, TELNET_LINEMODE_MODE, TELNET_LINEMODE_MODEMASK_ACK, TELNET_LINEMODE_MODEMASK_EDIT, TELNET_LINEMODE_MODEMASK_TRAPSIG, TELNET_LINEMODE_SLC, TELNET_LINEMODE_SLC_ACK, TELNET_LINEMODE_SLC_AO, TELNET_LINEMODE_SLC_AYT, TELNET_LINEMODE_SLC_BRK, TELNET_LINEMODE_SLC_CANTCHANGE, TELNET_LINEMODE_SLC_DEFAULT, TELNET_LINEMODE_SLC_EOF, TELNET_LINEMODE_SLC_EOR, TELNET_LINEMODE_SLC_IP, TELNET_LINEMODE_SLC_NOSUPPORT, TELNET_LINEMODE_SLC_SUSP, TELNET_LINEMODE_SLC_VALUE, TELNET_LINEMODE_SLC_XOFF, TELNET_LINEMODE_SLC_XON, TELNET_LOGOUT, TELNET_MSP, TELNET_MSSP, TELNET_MXP, TELNET_NAWS, TELNET_SB, TELNET_SE, TELNET_SUPRESS_GO_AHEAD, TELNET_TERMTYPE, TELNET_TOGGLE_FLOW_CONTROL, TELNET_WILL, TELNET_WONT
 
Constructor Summary
DefaultSession()
           
 
Method Summary
 boolean afkFlag()
          Returns whether this mob/session is currently Away From Keyboard
 java.lang.String afkMessage()
          Returns the reason given by the user that they are AFK.
 boolean amBeingSnoopedBy(Session S)
          Checks to see if the given session is snooping on this one.
 java.lang.String blockingIn()
          Blocks the current thread until the user attached to this session hits ENTER, returning the characters they enter.
 java.lang.String blockingIn(long maxTime)
           
 void changeTelnetMode(int telnetCode, boolean onOff)
          Change telnet mode by sending the appropriate command to the clients client.
 void changeTelnetModeBackwards(int telnetCode, boolean onOff)
           
 void changeTelnetModeBackwards(java.io.OutputStream out, int telnetCode, boolean onOff)
           
 java.lang.String choose(java.lang.String Message, java.lang.String Choices, java.lang.String Default)
          Prompts the user to enter one character responses from a set of valid choices.
 java.lang.String choose(java.lang.String Message, java.lang.String Choices, java.lang.String Default, long maxTime)
          Prompts the user to enter one character responses from a set of valid choices.
 java.lang.String choose(java.lang.String Message, java.lang.String Choices, java.lang.String Default, long maxTime, java.util.List<java.lang.String> paramsOut)
          Prompts the user to enter one character responses from a set of valid choices.
 boolean clientTelnetMode(int telnetCode)
          Gets a client telnet mode flag.
 java.lang.String[] clookup()
          Returns a list of telnet coded strings indexed by coffeemud color code.
protected  void closeSocks()
           
 void colorOnlyPrint(java.lang.String msg)
          Lower-Medium-level text output method.
 void colorOnlyPrint(java.lang.String msg, boolean noCache)
          Lower-Medium-level text output method.
 void colorOnlyPrintln(java.lang.String msg)
          Lower-Medium-level text output method.
 void colorOnlyPrintln(java.lang.String msg, boolean noCache)
          Lower-Medium-level text output method.
 int compareTo(CMObject o)
           
 boolean confirm(java.lang.String Message, java.lang.String Default)
          Prompts the user to enter Y or N, and returns what they enter.
 boolean confirm(java.lang.String Message, java.lang.String Default, long maxTime)
          Prompts the user to enter Y or N, and returns what they enter.
 CMObject copyOf()
          Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
 int currentColor()
          Returns the current color code.
protected  void errorOut(java.lang.Exception t)
           
 java.lang.String getAddress()
          Gets the current telnet clients ip address.
 int getColor(char c)
          Returns the given color code, unless it is one that translates to another, such as ?
 long getIdleMillis()
          Gets the number of milliseconds since a user entry was registered by this session
 java.util.List<java.lang.String> getLastMsgs()
          Returns a Vector of the last several message strings received by this user.
 long getLastNPCFight()
          Gets the milliseconds timestamp since this user last registered a npc fight.
 long getLastPKFight()
          Gets the milliseconds timestamp since this user last registered a pk fight.
 long getMillisOnline()
          Gets the milliseconds elapsed since this user came online.
 int getPageBreak()
           
 int getSaveStatIndex()
          Returns the index into the stat codes array where extra savable fields begins.
 java.lang.String getStat(java.lang.String code)
          An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
 java.lang.String[] getStatCodes()
          Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.
 int getStatus()
          Gets the tick/thread status of this session object.
 java.lang.String getTerminalType()
          Gets the terminal type the user has
 long getTotalMillis()
          Gets the total milliseconds consumed by this session objects thread.
 long getTotalTicks()
          Gets the total number of ticks consumed by this session object thread.
 int getWrap()
          Gets the column number for engine word-wrapping.
protected  long getWriteStartTime()
           
 void handleEscape()
           
 void handleIAC()
           
 void handleSubOption(int optionCode, char[] suboptionData, int dataSize)
           
 char hotkey(long maxWait)
          Waits the given milliseconds for a key to be pressed, after which it returns that key, or \0 if nothing pressed.
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 void initializeClass()
          Called ONCE after all objects are loaded, but before the map is read in during initialization.
 void initializeSession(java.net.Socket s, java.lang.String introTextStr)
          Negotiates various telnet options (or attempts to), and prints the introTextStr to the user.
 void initTelnetMode(int mobbitmap)
          Initializes a telnet mode between this session and the connected client by negotiating certain fundamental flags, like ANSI, MXP, and MSP.
 boolean isFake()
          Returns true if this session is merely a placeholder, and does not represent an actual user connection.
 boolean isLockedUpWriting()
          Checks whether this session is currently over its time limit trying to write data to its socket.
 boolean isStat(java.lang.String code)
          An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
 void kill(boolean removeMOB, boolean dropSession, boolean killThread)
          Force the current player to logoff.
 boolean killFlag()
          Returns whether this session is done, or slated to be done.
 int lastColor()
          Returns the previous current color code.
 long lastLoopTime()
          Returns the last time in milliseconds that this session began its input loop.
 void logout(boolean removeMOB)
          Allows the user to select a different character, taking them back to the login prompt, or to the account character listing screen, whichever is appropriate.
 java.lang.String makeEscape(int c)
          Converts a character after the ^ sign (usually a color code) into an appropriate telnet escape sequence string for output.
 MOB mob()
          Returns the player MOB attached to this session object.
 void negotiateTelnetMode(int telnetCode)
          Change telnet mode by negotiating the command to the clients client.
 CMObject newInstance()
          Returns a new instance of this class.
 int nonBlockingIn(boolean appendInputFlag)
           
 void onlyPrint(java.lang.String msg)
          Low level text output method.
 void onlyPrint(java.lang.String msg, boolean noCache)
          Low level text output method.
 void out(char c)
           
 void out(char[] c)
          Lowest level user-output method.
 void out(java.lang.String c)
           
 java.util.List<java.lang.String> previousCMD()
          Returns a pre-parsed, pre-filtered Vector of strings representing the last command entered by the user through this session.
 void print(Physical src, Environmental trg, Environmental tol, java.lang.String msg)
          Medium-level text output method.
 void print(java.lang.String msg)
          Medium-level text output method.
 void println(Physical src, Environmental trg, Environmental tol, java.lang.String msg)
          Medium-level text output method.
 void println(java.lang.String msg)
          Medium-level text output method.
 java.lang.String prompt(java.lang.String Message)
          Prompts the user to enter a string, and then returns what the enter.
 java.lang.String prompt(java.lang.String Message, long maxTime)
          Prompts the user to enter a string, and then returns what the enter.
 java.lang.String prompt(java.lang.String Message, java.lang.String Default)
          Prompts the user to enter a string, and then returns what the enter.
 java.lang.String prompt(java.lang.String Message, java.lang.String Default, long maxTime)
          Prompts the user to enter a string, and then returns what the enter.
 void rawOut(java.lang.String msg)
          Lowest level user-output method.
 void rawPrint(java.lang.String msg)
          Low level line-output method.
 void rawPrintln(java.lang.String msg)
          Low level line-output method.
 int read()
           
 java.lang.String readlineContinue()
          Blocks for a short amount of time, returning an input string only if the user happens to have hit enter.
 void run()
           
 boolean serverTelnetMode(int telnetCode)
          Gets a server telnet mode flag.
 void setAccount(PlayerAccount account)
          Sets the player acount attached to this session object.
 void setAfkFlag(boolean truefalse)
          Sets whether this mob/session is currently Away From Keyboard
 void setAFKMessage(java.lang.String str)
          Returns the reason given by the user that they are AFK.
 void setClientTelnetMode(int telnetCode, boolean onOff)
          Sets a client telnet mode flag.
 void setKillFlag(boolean truefalse)
           
 void setLastNPCFight()
          Sets now as the milliseconds timestamp since this user last registered a npc fight.
 void setLastPKFight()
          Sets now as the milliseconds timestamp since this user last registered a pk fight.
 void setMob(MOB newmob)
          Sets the player MOB attached to this session object.
 void setPreviousCmd(java.util.List cmds)
           
 void setPromptFlag(boolean truefalse)
          Notifies this session to output the users prompt again once it has reached a suitable lapse in text output.
 void setServerTelnetMode(int telnetCode, boolean onOff)
          Sets a server telnet mode flag.
 void setStat(java.lang.String code, java.lang.String val)
          An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
 void showPrompt()
           
 int snoopSuspension(int change)
          Increments or decrements the snoop suspension counter by the given amount.
 void startBeingSnoopedBy(Session S)
          Notifies this session that the given session is snooping it.
 void stdPrint(Physical src, Environmental trg, Environmental tol, java.lang.String msg)
          Higher-level line output method.
 void stdPrint(java.lang.String msg)
          Higher-level line output method.
 void stdPrintln(Physical src, Environmental trg, Environmental tol, java.lang.String msg)
          Higher-level line output method.
 void stdPrintln(java.lang.String msg)
          Higher-level line output method.
 void stopBeingSnoopedBy(Session S)
          Notifies this session that the given session is no longer snooping it.
 void updateLoopTime()
          Sets the last time in milliseconds that this session began its input loop.
 void wraplessPrint(java.lang.String msg)
          Medium-level text output method.
 void wraplessPrintln(java.lang.String msg)
          Medium-level text output method.
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.planet_ink.coffee_mud.Common.interfaces.Session
start
 

Field Detail

SOTIMEOUT

protected static final int SOTIMEOUT
See Also:
Constant Field Values

sessionCounter

protected static int sessionCounter

status

protected int status

snoopSuspensionStack

protected int snoopSuspensionStack

sock

protected java.net.Socket sock

in

protected java.io.BufferedReader in

out

protected java.io.PrintWriter out

rawout

protected java.io.OutputStream rawout

mob

protected MOB mob

acct

protected PlayerAccount acct

killFlag

protected boolean killFlag

needPrompt

protected boolean needPrompt

afkFlag

protected boolean afkFlag

afkMessage

protected java.lang.String afkMessage

input

protected java.lang.StringBuffer input

preliminaryInput

protected java.lang.StringBuffer preliminaryInput

fakeInput

protected java.lang.StringBuffer fakeInput

waiting

protected boolean waiting

previousCmd

protected java.util.List<java.lang.String> previousCmd

clookup

protected java.lang.String[] clookup

lastColorStr

protected java.lang.String lastColorStr

lastStr

protected java.lang.String lastStr

spamStack

protected int spamStack

snoops

protected java.util.List snoops

prevMsgs

protected java.util.List<java.lang.String> prevMsgs

curPrevMsg

protected java.lang.StringBuffer curPrevMsg

lastWasCR

protected boolean lastWasCR

lastWasLF

protected boolean lastWasLF

suspendCommandLine

protected boolean suspendCommandLine

serverTelnetCodes

protected boolean[] serverTelnetCodes

clientTelnetCodes

protected boolean[] clientTelnetCodes

terminalType

protected java.lang.String terminalType

terminalWidth

protected int terminalWidth

terminalHeight

protected int terminalHeight

writeStartTime

protected long writeStartTime

bNextByteIs255

protected boolean bNextByteIs255

connectionComplete

protected boolean connectionComplete

writeLock

protected java.util.concurrent.locks.ReentrantLock writeLock

currentColor

protected int currentColor

lastColor

protected int lastColor

lastStart

protected long lastStart

lastStop

protected long lastStop

lastLoopTop

protected long lastLoopTop

userLoginTime

protected long userLoginTime

onlineTime

protected long onlineTime

lastPKFight

protected long lastPKFight

lastNPCFight

protected long lastNPCFight

lastBlahCheck

protected long lastBlahCheck

milliTotal

protected long milliTotal

tickTotal

protected long tickTotal

lastKeystroke

protected long lastKeystroke

promptLastShown

protected long promptLastShown
Constructor Detail

DefaultSession

public DefaultSession()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Returns:
the name of this class

newInstance

public CMObject newInstance()
Description copied from interface: CMObject
Returns a new instance of this class.

Specified by:
newInstance in interface CMObject
Returns:
a new instance of this class

initializeClass

public void initializeClass()
Description copied from interface: CMObject
Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:
initializeClass in interface CMObject

isFake

public boolean isFake()
Description copied from interface: Session
Returns true if this session is merely a placeholder, and does not represent an actual user connection. Will ensure that the system continues to treat the user as a mob.

Specified by:
isFake in interface Session
Returns:
true if this session is not a connection

copyOf

public CMObject copyOf()
Description copied from interface: CMObject
Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:
copyOf in interface CMObject
Returns:
a clone of this object

compareTo

public int compareTo(CMObject o)
Specified by:
compareTo in interface java.lang.Comparable<CMObject>

initializeSession

public void initializeSession(java.net.Socket s,
                              java.lang.String introTextStr)
Description copied from interface: Session
Negotiates various telnet options (or attempts to), and prints the introTextStr to the user.

Specified by:
initializeSession in interface Session
Parameters:
s - the socket the user connected from
introTextStr - introductory text string (Hello!)

setServerTelnetMode

public void setServerTelnetMode(int telnetCode,
                                boolean onOff)
Description copied from interface: Session
Sets a server telnet mode flag.

Specified by:
setServerTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
onOff - true to turn on, false to turn off the flag
See Also:
Session.TELNET_ANSI, Session.serverTelnetMode(int)

serverTelnetMode

public boolean serverTelnetMode(int telnetCode)
Description copied from interface: Session
Gets a server telnet mode flag.

Specified by:
serverTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
Returns:
true, if server telnet mode is on, false otherwise
See Also:
Session.TELNET_ANSI, Session.setServerTelnetMode(int, boolean)

setClientTelnetMode

public void setClientTelnetMode(int telnetCode,
                                boolean onOff)
Description copied from interface: Session
Sets a client telnet mode flag.

Specified by:
setClientTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
onOff - true to turn on, false to turn off the flag
See Also:
Session.TELNET_ANSI, Session.clientTelnetMode(int)

clientTelnetMode

public boolean clientTelnetMode(int telnetCode)
Description copied from interface: Session
Gets a client telnet mode flag.

Specified by:
clientTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
Returns:
true, if client telnet mode is on, false otherwise
See Also:
Session.TELNET_ANSI, Session.setClientTelnetMode(int, boolean)

changeTelnetMode

public void changeTelnetMode(int telnetCode,
                             boolean onOff)
Description copied from interface: Session
Change telnet mode by sending the appropriate command to the clients client. A response received later will trigger mode changed.

Specified by:
changeTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
onOff - true to turn on, false to turn off the flag
See Also:
Session.TELNET_ANSI, Session.setClientTelnetMode(int, boolean), Session.setServerTelnetMode(int, boolean)

changeTelnetModeBackwards

public void changeTelnetModeBackwards(int telnetCode,
                                      boolean onOff)

changeTelnetModeBackwards

public void changeTelnetModeBackwards(java.io.OutputStream out,
                                      int telnetCode,
                                      boolean onOff)
                               throws java.io.IOException
Throws:
java.io.IOException

negotiateTelnetMode

public void negotiateTelnetMode(int telnetCode)
Description copied from interface: Session
Change telnet mode by negotiating the command to the clients client.

Specified by:
negotiateTelnetMode in interface Session
Parameters:
telnetCode - the telnet code
See Also:
Session.TELNET_ANSI, Session.setClientTelnetMode(int, boolean), Session.setServerTelnetMode(int, boolean)

initTelnetMode

public void initTelnetMode(int mobbitmap)
Description copied from interface: Session
Initializes a telnet mode between this session and the connected client by negotiating certain fundamental flags, like ANSI, MXP, and MSP. It will use a bitmap of MOB flags passed in as a guide.

Specified by:
initTelnetMode in interface Session
Parameters:
mobbitmap - the mobbitmap the bitmap of mob flags to use as a guide in negotiation
See Also:
MOB.getBitmap(), MOB.ATT_MXP, Session.changeTelnetMode(int, boolean)

currentColor

public int currentColor()
Description copied from interface: Session
Returns the current color code.

Specified by:
currentColor in interface Session
Returns:
the current color code.
See Also:
Session.getColor(char), Session.makeEscape(int), Session.lastColor()

lastColor

public int lastColor()
Description copied from interface: Session
Returns the previous current color code.

Specified by:
lastColor in interface Session
Returns:
the previous current color code.
See Also:
Session.getColor(char), Session.currentColor(), Session.makeEscape(int)

getTotalMillis

public long getTotalMillis()
Description copied from interface: Session
Gets the total milliseconds consumed by this session objects thread.

Specified by:
getTotalMillis in interface Session
Returns:
the total milliseconds consumed

getIdleMillis

public long getIdleMillis()
Description copied from interface: Session
Gets the number of milliseconds since a user entry was registered by this session

Specified by:
getIdleMillis in interface Session
Returns:
the idle milliseconds passed

getTotalTicks

public long getTotalTicks()
Description copied from interface: Session
Gets the total number of ticks consumed by this session object thread.

Specified by:
getTotalTicks in interface Session
Returns:
the total ticks consumed

getMillisOnline

public long getMillisOnline()
Description copied from interface: Session
Gets the milliseconds elapsed since this user came online.

Specified by:
getMillisOnline in interface Session
Returns:
the milliseconds online

lastLoopTime

public long lastLoopTime()
Description copied from interface: Session
Returns the last time in milliseconds that this session began its input loop. Is typically only held up by executing a user command, so it is an accurate gauge of a locked up user command.

Specified by:
lastLoopTime in interface Session
Returns:
the last time in milliseconds that this session began its input loop
See Also:
Session.updateLoopTime()

updateLoopTime

public void updateLoopTime()
Description copied from interface: Session
Sets the last time in milliseconds that this session began its input loop. Is typically only held up by executing a user command, so it is an accurate gauge of a locked up user command.

Specified by:
updateLoopTime in interface Session
See Also:
Session.lastLoopTime()

getLastPKFight

public long getLastPKFight()
Description copied from interface: Session
Gets the milliseconds timestamp since this user last registered a pk fight.

Specified by:
getLastPKFight in interface Session
Returns:
the last pk fight timestamp
See Also:
Session.setLastPKFight(), Session.setLastNPCFight()

setLastPKFight

public void setLastPKFight()
Description copied from interface: Session
Sets now as the milliseconds timestamp since this user last registered a pk fight.

Specified by:
setLastPKFight in interface Session
See Also:
Session.getLastPKFight(), Session.getLastNPCFight()

getLastNPCFight

public long getLastNPCFight()
Description copied from interface: Session
Gets the milliseconds timestamp since this user last registered a npc fight.

Specified by:
getLastNPCFight in interface Session
Returns:
the last npc fight timestamp
See Also:
Session.setLastPKFight(), Session.setLastNPCFight()

setLastNPCFight

public void setLastNPCFight()
Description copied from interface: Session
Sets now as the milliseconds timestamp since this user last registered a npc fight.

Specified by:
setLastNPCFight in interface Session
See Also:
Session.getLastPKFight(), Session.getLastNPCFight()

getLastMsgs

public java.util.List<java.lang.String> getLastMsgs()
Description copied from interface: Session
Returns a Vector of the last several message strings received by this user. All are already previously filtered and parsed and ready to display.

Specified by:
getLastMsgs in interface Session
Returns:
a vector of string message strings

getTerminalType

public java.lang.String getTerminalType()
Description copied from interface: Session
Gets the terminal type the user has

Specified by:
getTerminalType in interface Session
Returns:
the terminal type

mob

public MOB mob()
Description copied from interface: Session
Returns the player MOB attached to this session object.

Specified by:
mob in interface Session
Returns:
the player MOB attached to this session object.
See Also:
Session.setMob(MOB)

setMob

public void setMob(MOB newmob)
Description copied from interface: Session
Sets the player MOB attached to this session object.

Specified by:
setMob in interface Session
Parameters:
newmob - the player MOB attached to this session object.
See Also:
Session.mob()

setAccount

public void setAccount(PlayerAccount account)
Description copied from interface: Session
Sets the player acount attached to this session object.

Specified by:
setAccount in interface Session
Parameters:
account - the player account attached to this session object.
See Also:
Session.mob()

getWrap

public int getWrap()
Description copied from interface: Session
Gets the column number for engine word-wrapping. 0 Means disabled.

Specified by:
getWrap in interface Session
Returns:
the wrap column

getPageBreak

public int getPageBreak()

killFlag

public boolean killFlag()
Description copied from interface: Session
Returns whether this session is done, or slated to be done.

Specified by:
killFlag in interface Session
Returns:
true if this session needs to go, false otherwise
See Also:
Session.logout(boolean), Session.killFlag()

setKillFlag

public void setKillFlag(boolean truefalse)

previousCMD

public java.util.List<java.lang.String> previousCMD()
Description copied from interface: Session
Returns a pre-parsed, pre-filtered Vector of strings representing the last command entered by the user through this session.

Specified by:
previousCMD in interface Session
Returns:
a vector of strings

startBeingSnoopedBy

public void startBeingSnoopedBy(Session S)
Description copied from interface: Session
Notifies this session that the given session is snooping it. This session will manage said snooping.

Specified by:
startBeingSnoopedBy in interface Session
Parameters:
S - the session to snoop on me.
See Also:
Session.startBeingSnoopedBy(Session), Session.stopBeingSnoopedBy(Session), Session.amBeingSnoopedBy(Session), Session.snoopSuspension(int)

stopBeingSnoopedBy

public void stopBeingSnoopedBy(Session S)
Description copied from interface: Session
Notifies this session that the given session is no longer snooping it. This session will remove said snooping.

Specified by:
stopBeingSnoopedBy in interface Session
Parameters:
S - the session to stop snooping on me.
See Also:
Session.startBeingSnoopedBy(Session), Session.stopBeingSnoopedBy(Session), Session.amBeingSnoopedBy(Session), Session.snoopSuspension(int)

amBeingSnoopedBy

public boolean amBeingSnoopedBy(Session S)
Description copied from interface: Session
Checks to see if the given session is snooping on this one.

Specified by:
amBeingSnoopedBy in interface Session
Parameters:
S - the session to check for a snoop on me.
Returns:
true if the given session is snooping on me, false otherwise
See Also:
Session.startBeingSnoopedBy(Session), Session.stopBeingSnoopedBy(Session), Session.amBeingSnoopedBy(Session), Session.snoopSuspension(int)

snoopSuspension

public int snoopSuspension(int change)
Description copied from interface: Session
Increments or decrements the snoop suspension counter by the given amount. Only when the counter is 0 does snooping of this session actually occur.

Specified by:
snoopSuspension in interface Session
Parameters:
change - the amount to change the snoop suspension counter by
Returns:
the current value of the snoop suspension counter after the change
See Also:
Session.startBeingSnoopedBy(Session), Session.stopBeingSnoopedBy(Session), Session.amBeingSnoopedBy(Session), Session.snoopSuspension(int)

setPreviousCmd

public void setPreviousCmd(java.util.List cmds)

afkFlag

public boolean afkFlag()
Description copied from interface: Session
Returns whether this mob/session is currently Away From Keyboard

Specified by:
afkFlag in interface Session
Returns:
true if they are AFK, false otherwise
See Also:
Session.setAfkFlag(boolean), Session.setAFKMessage(String)

setAfkFlag

public void setAfkFlag(boolean truefalse)
Description copied from interface: Session
Sets whether this mob/session is currently Away From Keyboard

Specified by:
setAfkFlag in interface Session
Parameters:
truefalse - true if they are AFK, false otherwise
See Also:
Session.afkFlag(), Session.afkMessage()

afkMessage

public java.lang.String afkMessage()
Description copied from interface: Session
Returns the reason given by the user that they are AFK.

Specified by:
afkMessage in interface Session
Returns:
the reason given by the user that they are AFK.
See Also:
Session.setAfkFlag(boolean), Session.setAFKMessage(String)

setAFKMessage

public void setAFKMessage(java.lang.String str)
Description copied from interface: Session
Returns the reason given by the user that they are AFK.

Specified by:
setAFKMessage in interface Session
Parameters:
str - the reason given by the user that they are AFK.
See Also:
Session.setAfkFlag(boolean), Session.afkMessage()

errorOut

protected void errorOut(java.lang.Exception t)

getWriteStartTime

protected long getWriteStartTime()

isLockedUpWriting

public boolean isLockedUpWriting()
Description copied from interface: Session
Checks whether this session is currently over its time limit trying to write data to its socket. For some reason this happens, and this method detects it.

Specified by:
isLockedUpWriting in interface Session
Returns:
true if something bas happened, false otherwise

out

public void out(char[] c)
Description copied from interface: Session
Lowest level user-output method. Does nothing but send the string to the user, period.

Specified by:
out in interface Session
Parameters:
c - string (as char array) to send out to the user

out

public void out(java.lang.String c)

out

public void out(char c)

onlyPrint

public void onlyPrint(java.lang.String msg)
Description copied from interface: Session
Low level text output method. Implements such features as snoops, spam-stacking. No page breaking, and Always line caching

Specified by:
onlyPrint in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

onlyPrint

public void onlyPrint(java.lang.String msg,
                      boolean noCache)
Description copied from interface: Session
Low level text output method. Implements such features as snoops, spam-stacking, page breaks, and line caching

Specified by:
onlyPrint in interface Session
Parameters:
msg - the string to send to the user
noCache - true to disable line caching, false otherwise
See Also:
Session.out(char[])

rawOut

public void rawOut(java.lang.String msg)
Description copied from interface: Session
Lowest level user-output method. Does nothing but send the string to the user, period.

Specified by:
rawOut in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.out(char[])

rawPrint

public void rawPrint(java.lang.String msg)
Description copied from interface: Session
Low level line-output method. Sets the prompt flag after write, and inserts additional pre-linefeed if currently at the prompt.

Specified by:
rawPrint in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.rawPrint(String)

print

public void print(java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes. Does not manage the prompt.

Specified by:
print in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

rawPrintln

public void rawPrintln(java.lang.String msg)
Description copied from interface: Session
Low level line-output method. Sets the prompt flag after write, and inserts additional pre-linefeed if currently at the prompt. Adds post linefeed of course. Does not do a page break.

Specified by:
rawPrintln in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.rawPrintln(String)

stdPrint

public void stdPrint(java.lang.String msg)
Description copied from interface: Session
Higher-level line output method. Does full filtering of special characters and codes.

Specified by:
stdPrint in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.rawPrint(String)

print

public void print(Physical src,
                  Environmental trg,
                  Environmental tol,
                  java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes using given variable values. Does not manage the prompt.

Specified by:
print in interface Session
Parameters:
src - variable for special code parsing: Source
trg - variable for special code parsing: Target
tol - variable for special code parsing: Tool
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

stdPrint

public void stdPrint(Physical src,
                     Environmental trg,
                     Environmental tol,
                     java.lang.String msg)
Description copied from interface: Session
Higher-level line output method. Does full filtering of special characters and codes using given variable values.

Specified by:
stdPrint in interface Session
Parameters:
src - variable for special code parsing: Source
trg - variable for special code parsing: Target
tol - variable for special code parsing: Tool
msg - the string to send to the user
See Also:
Session.rawPrint(String)

println

public void println(java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes. Does not manage the prompt. Adds a linefeed at the end though.

Specified by:
println in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

wraplessPrintln

public void wraplessPrintln(java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes. DOES manage the prompt, but turns OFF word wrap! Adds a linefeed at the end.

Specified by:
wraplessPrintln in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

wraplessPrint

public void wraplessPrint(java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes. DOES manage the prompt, but turns OFF word wrap!

Specified by:
wraplessPrint in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

colorOnlyPrintln

public void colorOnlyPrintln(java.lang.String msg)
Description copied from interface: Session
Lower-Medium-level text output method. Does only the parsing of color codes, no word wrapping, no codes. Adds a linefeed at the end.

Specified by:
colorOnlyPrintln in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

colorOnlyPrintln

public void colorOnlyPrintln(java.lang.String msg,
                             boolean noCache)
Description copied from interface: Session
Lower-Medium-level text output method. Does only the parsing of color codes, no word wrapping, no codes. Adds a linefeed at the end.

Specified by:
colorOnlyPrintln in interface Session
Parameters:
msg - the string to send to the user
noCache - true to disable line caching, false otherwise
See Also:
Session.onlyPrint(String, boolean)

colorOnlyPrint

public void colorOnlyPrint(java.lang.String msg)
Description copied from interface: Session
Lower-Medium-level text output method. Does only the parsing of color codes, no word wrapping, no codes.

Specified by:
colorOnlyPrint in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

colorOnlyPrint

public void colorOnlyPrint(java.lang.String msg,
                           boolean noCache)
Description copied from interface: Session
Lower-Medium-level text output method. Does only the parsing of color codes, no word wrapping, no codes.

Specified by:
colorOnlyPrint in interface Session
Parameters:
msg - the string to send to the user
noCache - true to disable line caching, false otherwise
See Also:
Session.onlyPrint(String, boolean)

stdPrintln

public void stdPrintln(java.lang.String msg)
Description copied from interface: Session
Higher-level line output method. Does full filtering of special characters and codes.

Specified by:
stdPrintln in interface Session
Parameters:
msg - the string to send to the user
See Also:
Session.rawPrintln(String)

println

public void println(Physical src,
                    Environmental trg,
                    Environmental tol,
                    java.lang.String msg)
Description copied from interface: Session
Medium-level text output method. Does full filtering of special characters and codes using given variable values. Does not manage the prompt. Adds a linefeed at the end though.

Specified by:
println in interface Session
Parameters:
src - variable for special code parsing: Source
trg - variable for special code parsing: Target
tol - variable for special code parsing: Tool
msg - the string to send to the user
See Also:
Session.onlyPrint(String, boolean)

stdPrintln

public void stdPrintln(Physical src,
                       Environmental trg,
                       Environmental tol,
                       java.lang.String msg)
Description copied from interface: Session
Higher-level line output method. Does full filtering of special characters and codes using given variable values.

Specified by:
stdPrintln in interface Session
Parameters:
src - variable for special code parsing: Source
trg - variable for special code parsing: Target
tol - variable for special code parsing: Tool
msg - the string to send to the user
See Also:
Session.rawPrintln(String)

setPromptFlag

public void setPromptFlag(boolean truefalse)
Description copied from interface: Session
Notifies this session to output the users prompt again once it has reached a suitable lapse in text output.

Specified by:
setPromptFlag in interface Session
Parameters:
truefalse - true to send another prompt, false otherwise

prompt

public java.lang.String prompt(java.lang.String Message,
                               java.lang.String Default,
                               long maxTime)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter a string, and then returns what the enter. Possibly times out, and may throw an exception on disconnnect or time out.

Specified by:
prompt in interface Session
Parameters:
Message - the prompt message to display to the user
Default - the default response if the user just hits enter
maxTime - max number of milliseconds to wait before timing out
Returns:
the string entered by the user, or the Default
Throws:
java.io.IOException - a disconnect or time out
See Also:
Session.prompt(String), Session.prompt(String, String), Session.prompt(String, long)

prompt

public java.lang.String prompt(java.lang.String Message,
                               java.lang.String Default)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter a string, and then returns what the enter. Does not time out, but may throw an exception on disconnnect.

Specified by:
prompt in interface Session
Parameters:
Message - the prompt message to display to the user
Default - the default response if the user just hits enter
Returns:
the string entered by the user, or the Default
Throws:
java.io.IOException - a disconnect
See Also:
Session.prompt(String), Session.prompt(String, long), Session.prompt(String, String, long)

prompt

public java.lang.String prompt(java.lang.String Message,
                               long maxTime)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter a string, and then returns what the enter. Possibly times out, and may throw an exception on disconnnect or time out.

Specified by:
prompt in interface Session
Parameters:
Message - the prompt message to display to the user
maxTime - max number of milliseconds to wait before timing out
Returns:
the string entered by the user
Throws:
java.io.IOException - a disconnect or time out
See Also:
Session.prompt(String), Session.prompt(String, String), Session.prompt(String, String, long)

prompt

public java.lang.String prompt(java.lang.String Message)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter a string, and then returns what the enter. Does not time out, but may throw an exception on disconnnect.

Specified by:
prompt in interface Session
Parameters:
Message - the prompt message to display to the user
Returns:
the string entered by the user
Throws:
java.io.IOException - a disconnect
See Also:
Session.prompt(String, String), Session.prompt(String, long), Session.prompt(String, String, long)

getColor

public int getColor(char c)
Description copied from interface: Session
Returns the given color code, unless it is one that translates to another, such as ?

Specified by:
getColor in interface Session
Parameters:
c - the color code
Returns:
the color code again
See Also:
Session.makeEscape(int), Session.currentColor(), Session.lastColor()

clookup

public java.lang.String[] clookup()
Description copied from interface: Session
Returns a list of telnet coded strings indexed by coffeemud color code. May be from the standard list, or read from player records for a customized list.

Specified by:
clookup in interface Session
Returns:
telnet coded color strings.

makeEscape

public java.lang.String makeEscape(int c)
Description copied from interface: Session
Converts a character after the ^ sign (usually a color code) into an appropriate telnet escape sequence string for output.

Specified by:
makeEscape in interface Session
Parameters:
c - the ^ character code
Returns:
telnet escape sequence string for output
See Also:
Session.getColor(char), Session.currentColor(), Session.lastColor()

handleSubOption

public void handleSubOption(int optionCode,
                            char[] suboptionData,
                            int dataSize)
                     throws java.io.IOException
Throws:
java.io.IOException

handleEscape

public void handleEscape()
                  throws java.io.IOException,
                         java.io.InterruptedIOException
Throws:
java.io.IOException
java.io.InterruptedIOException

handleIAC

public void handleIAC()
               throws java.io.IOException,
                      java.io.InterruptedIOException
Throws:
java.io.IOException
java.io.InterruptedIOException

read

public int read()
         throws java.io.IOException
Throws:
java.io.IOException

hotkey

public char hotkey(long maxWait)
Description copied from interface: Session
Waits the given milliseconds for a key to be pressed, after which it returns that key, or \0 if nothing pressed.

Specified by:
hotkey in interface Session
Parameters:
maxWait - the maximum milliseconds to wait
Returns:
the key pressed, or \0

nonBlockingIn

public int nonBlockingIn(boolean appendInputFlag)
                  throws java.io.IOException
Throws:
java.io.IOException

blockingIn

public java.lang.String blockingIn(long maxTime)
                            throws java.io.IOException
Throws:
java.io.IOException

blockingIn

public java.lang.String blockingIn()
                            throws java.io.IOException
Description copied from interface: Session
Blocks the current thread until the user attached to this session hits ENTER, returning the characters they enter. Completely filtered input.

Specified by:
blockingIn in interface Session
Returns:
the string entered by the user
Throws:
java.io.IOException - any exception generated during input

readlineContinue

public java.lang.String readlineContinue()
                                  throws java.io.IOException,
                                         java.net.SocketException
Description copied from interface: Session
Blocks for a short amount of time, returning an input string only if the user happens to have hit enter.

Specified by:
readlineContinue in interface Session
Returns:
a string entered by the user
Throws:
java.io.IOException - exceptions thrown, typically a timeout
java.net.SocketException

confirm

public boolean confirm(java.lang.String Message,
                       java.lang.String Default,
                       long maxTime)
                throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter Y or N, and returns what they enter. Possibly times out, and may throw an exception on disconnnect or time out.

Specified by:
confirm in interface Session
Parameters:
Message - the prompt message to display to the user
Default - the default response if the user just hits enter
maxTime - max number of milliseconds to wait before timing out
Returns:
true if they entered Y, false otherwise
Throws:
java.io.IOException - a disconnect or time out
See Also:
Session.confirm(String, String)

confirm

public boolean confirm(java.lang.String Message,
                       java.lang.String Default)
                throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter Y or N, and returns what they enter. Will not time out, but may throw an exception on disconnect.

Specified by:
confirm in interface Session
Parameters:
Message - the prompt message to display to the user
Default - the default response if the user just hits enter
Returns:
true if they entered Y, false otherwise
Throws:
java.io.IOException - a disconnect
See Also:
Session.confirm(String, String, long)

choose

public java.lang.String choose(java.lang.String Message,
                               java.lang.String Choices,
                               java.lang.String Default)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter one character responses from a set of valid choices. Repeats the prompt if the user does not enter a valid choice. ENTER is a valid choice for Default. Does not time out, but may throw an exception on disconnnect.

Specified by:
choose in interface Session
Parameters:
Message - the prompt message to display to the user
Choices - a list of uppercase characters that may be entered
Default - the default response if the user just hits enter
Returns:
the character entered from the choices
Throws:
java.io.IOException - a disconnect
See Also:
Session.choose(String, String, String, long)

choose

public java.lang.String choose(java.lang.String Message,
                               java.lang.String Choices,
                               java.lang.String Default,
                               long maxTime)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter one character responses from a set of valid choices. Repeats the prompt if the user does not enter a valid choice. ENTER is a valid choice for Default. May time out, and may throw an exception on disconnnect.

Specified by:
choose in interface Session
Parameters:
Message - the prompt message to display to the user
Choices - a list of uppercase characters that may be entered
Default - the default response if the user just hits enter
maxTime - max number of milliseconds to wait before timing out
Returns:
the character entered from the choices
Throws:
java.io.IOException - a disconnect or time out
See Also:
Session.choose(String, String, String)

choose

public java.lang.String choose(java.lang.String Message,
                               java.lang.String Choices,
                               java.lang.String Default,
                               long maxTime,
                               java.util.List<java.lang.String> paramsOut)
                        throws java.io.IOException
Description copied from interface: Session
Prompts the user to enter one character responses from a set of valid choices. Repeats the prompt if the user does not enter a valid choice. ENTER is a valid choice for Default. Does not time out, but may throw an exception on disconnnect.

Specified by:
choose in interface Session
Parameters:
Message - the prompt message to display to the user
Choices - a list of uppercase characters that may be entered
Default - the default response if the user just hits enter
maxTime - max number of milliseconds to wait before timing out
paramsOut - an empty list to put any extra crap added to the end of the choice.
Returns:
the character entered from the choices
Throws:
java.io.IOException - a disconnect
See Also:
Session.choose(String, String, String, long)

kill

public void kill(boolean removeMOB,
                 boolean dropSession,
                 boolean killThread)
Description copied from interface: Session
Force the current player to logoff.

Specified by:
kill in interface Session
Parameters:
removeMOB - true to remove the mob from the game
dropSession - true to force closed sockets, and removed session
killThread - true to force a thread death, and false to be more lenient
See Also:
Session.killFlag()

showPrompt

public void showPrompt()

closeSocks

protected void closeSocks()

getAddress

public java.lang.String getAddress()
Description copied from interface: Session
Gets the current telnet clients ip address.

Specified by:
getAddress in interface Session
Returns:
the ip address

getStatus

public int getStatus()
Description copied from interface: Session
Gets the tick/thread status of this session object.

Specified by:
getStatus in interface Session
Returns:
the tick status
See Also:
Session.STATUS_LOGIN

logout

public void logout(boolean removeMOB)
Description copied from interface: Session
Allows the user to select a different character, taking them back to the login prompt, or to the account character listing screen, whichever is appropriate.

Specified by:
logout in interface Session
Parameters:
removeMOB - true to remove the mob from the game

run

public void run()
Specified by:
run in interface java.lang.Runnable
Overrides:
run in class java.lang.Thread

getSaveStatIndex

public int getSaveStatIndex()
Description copied from interface: Modifiable
Returns the index into the stat codes array where extra savable fields begins. This number is always the same as getStatCodes().length unless there are extra fields which need to be saved in xml for generic objects. This method is used by editors for post-build user-defined fields.

Specified by:
getSaveStatIndex in interface Modifiable
Returns:
the index into getStatCodes()
See Also:
Modifiable.getStatCodes(), Modifiable.getStat(String), Modifiable.setStat(String, String)

getStatCodes

public java.lang.String[] getStatCodes()
Description copied from interface: Modifiable
Returns an array of the string names of those fields which are modifiable on this object at run-time by builders.

Specified by:
getStatCodes in interface Modifiable
Returns:
list of the fields which may be set.
See Also:
Modifiable.getStat(String), Modifiable.setStat(String, String)

isStat

public boolean isStat(java.lang.String code)
Description copied from interface: Modifiable
An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:
isStat in interface Modifiable
Parameters:
code - the name of the field to read.
Returns:
true if the code is a real value, false otherwise
See Also:
Modifiable.getStatCodes()

getStat

public java.lang.String getStat(java.lang.String code)
Description copied from interface: Modifiable
An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:
getStat in interface Modifiable
Parameters:
code - the name of the field to read.
Returns:
the value of the field read
See Also:
Modifiable.getStatCodes()

setStat

public void setStat(java.lang.String code,
                    java.lang.String val)
Description copied from interface: Modifiable
An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.

Specified by:
setStat in interface Modifiable
Parameters:
code - the name of the field to set
val - the value to set the field to
See Also:
Modifiable.getStatCodes()