com.planet_ink.coffee_mud.Common
Class DefaultJournalEntry

java.lang.Object
  extended by com.planet_ink.coffee_mud.Common.DefaultJournalEntry
All Implemented Interfaces:
CMCommon, JournalEntry, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultJournalEntry
extends java.lang.Object
implements JournalEntry


Field Summary
 long attributes
           
 int cardinal
           
 java.lang.String data
           
 long date
           
 java.lang.StringBuffer derivedBuildMessage
           
 java.lang.String from
           
 boolean isLastEntry
           
 java.lang.String key
           
 java.lang.String msg
           
 java.lang.String msgIcon
           
 java.lang.String parent
           
 int replies
           
 java.lang.String subj
           
 java.lang.String to
           
 long update
           
 int views
           
 
Fields inherited from interface com.planet_ink.coffee_mud.Common.interfaces.JournalEntry
ATTRIBUTE_PROTECTED, ATTRIBUTE_STUCKY
 
Constructor Summary
DefaultJournalEntry()
           
 
Method Summary
 long attributes()
           
 JournalEntry attributes(long attributes)
           
 int cardinal()
           
 JournalEntry cardinal(int cardinal)
           
 int compareTo(CMObject o)
           
 int compareTo(JournalEntry o)
           
 JournalEntry copyOf()
          Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
 java.lang.String data()
           
 JournalEntry data(java.lang.String data)
           
 long date()
           
 JournalEntry date(long date)
           
 java.lang.StringBuffer derivedBuildMessage()
           
 JournalEntry derivedBuildMessage(java.lang.StringBuffer msg)
           
 java.lang.String from()
           
 JournalEntry from(java.lang.String from)
           
 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.
 boolean isLastEntry()
           
 java.lang.String key()
           
 JournalEntry key(java.lang.String key)
           
 JournalEntry lastEntry(boolean lastEntry)
           
 java.lang.String msg()
           
 JournalEntry msg(java.lang.String msg)
           
 java.lang.String msgIcon()
           
 JournalEntry msgIcon(java.lang.String msgIcon)
           
 java.lang.String name()
          The displayable name of this object.
 CMObject newInstance()
          Returns a new instance of this class.
 java.lang.String parent()
           
 JournalEntry parent(java.lang.String parent)
           
 int replies()
           
 JournalEntry replies(int replies)
           
 java.lang.String subj()
           
 JournalEntry subj(java.lang.String subj)
           
 java.lang.String to()
           
 JournalEntry to(java.lang.String to)
           
 long update()
           
 JournalEntry update(long update)
           
 int views()
           
 JournalEntry views(int views)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

key

public java.lang.String key

from

public java.lang.String from

to

public java.lang.String to

subj

public java.lang.String subj

msg

public java.lang.String msg

date

public long date

update

public long update

parent

public java.lang.String parent

attributes

public long attributes

data

public java.lang.String data

cardinal

public int cardinal

msgIcon

public java.lang.String msgIcon

replies

public int replies

views

public int views

isLastEntry

public boolean isLastEntry

derivedBuildMessage

public java.lang.StringBuffer derivedBuildMessage
Constructor Detail

DefaultJournalEntry

public DefaultJournalEntry()
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, Tech. The name is typically identical to the class name.

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

name

public java.lang.String name()
Description copied from interface: CMObject
The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:
name in interface CMObject
Returns:
the modified final name of this object on the map.
See Also:
Environmental.Name()

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

compareTo

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

key

public java.lang.String key()
Specified by:
key in interface JournalEntry

key

public JournalEntry key(java.lang.String key)
Specified by:
key in interface JournalEntry

from

public java.lang.String from()
Specified by:
from in interface JournalEntry

from

public JournalEntry from(java.lang.String from)
Specified by:
from in interface JournalEntry

to

public java.lang.String to()
Specified by:
to in interface JournalEntry

to

public JournalEntry to(java.lang.String to)
Specified by:
to in interface JournalEntry

subj

public java.lang.String subj()
Specified by:
subj in interface JournalEntry

subj

public JournalEntry subj(java.lang.String subj)
Specified by:
subj in interface JournalEntry

msg

public java.lang.String msg()
Specified by:
msg in interface JournalEntry

msg

public JournalEntry msg(java.lang.String msg)
Specified by:
msg in interface JournalEntry

date

public long date()
Specified by:
date in interface JournalEntry

date

public JournalEntry date(long date)
Specified by:
date in interface JournalEntry

update

public long update()
Specified by:
update in interface JournalEntry

update

public JournalEntry update(long update)
Specified by:
update in interface JournalEntry

parent

public java.lang.String parent()
Specified by:
parent in interface JournalEntry

parent

public JournalEntry parent(java.lang.String parent)
Specified by:
parent in interface JournalEntry

attributes

public long attributes()
Specified by:
attributes in interface JournalEntry

attributes

public JournalEntry attributes(long attributes)
Specified by:
attributes in interface JournalEntry

data

public java.lang.String data()
Specified by:
data in interface JournalEntry

data

public JournalEntry data(java.lang.String data)
Specified by:
data in interface JournalEntry

cardinal

public int cardinal()
Specified by:
cardinal in interface JournalEntry

cardinal

public JournalEntry cardinal(int cardinal)
Specified by:
cardinal in interface JournalEntry

msgIcon

public java.lang.String msgIcon()
Specified by:
msgIcon in interface JournalEntry

msgIcon

public JournalEntry msgIcon(java.lang.String msgIcon)
Specified by:
msgIcon in interface JournalEntry

replies

public int replies()
Specified by:
replies in interface JournalEntry

replies

public JournalEntry replies(int replies)
Specified by:
replies in interface JournalEntry

views

public int views()
Specified by:
views in interface JournalEntry

views

public JournalEntry views(int views)
Specified by:
views in interface JournalEntry

isLastEntry

public boolean isLastEntry()
Specified by:
isLastEntry in interface JournalEntry

lastEntry

public JournalEntry lastEntry(boolean lastEntry)
Specified by:
lastEntry in interface JournalEntry

derivedBuildMessage

public java.lang.StringBuffer derivedBuildMessage()
Specified by:
derivedBuildMessage in interface JournalEntry

derivedBuildMessage

public JournalEntry derivedBuildMessage(java.lang.StringBuffer msg)
Specified by:
derivedBuildMessage in interface JournalEntry

compareTo

public int compareTo(JournalEntry o)
Specified by:
compareTo in interface JournalEntry

copyOf

public JournalEntry 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 JournalEntry
Specified by:
copyOf in interface CMObject
Returns:
a clone of this object