Package com.planet_ink.coffee_mud.Common

Class DefaultJournalEntry

java.lang.Object

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Common.interfaces.JournalEntry

JournalEntry.JournalAttrib

Field Summary

Fields

Modifier and Type	Field	Description
java.util.List<java.lang.String>	attachments
long	attributes
int	cardinal
java.lang.String	data
long	date
java.lang.String	dateStr
java.lang.StringBuffer	derivedBuildMessage
long	expiration
java.lang.String	from
int	hashCode
boolean	isLastEntry
java.lang.String	key
protected java.lang.String	knownClockName
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.core.interfaces.CMObject

idConverter

Constructor Summary

Constructors

Constructor	Description
DefaultJournalEntry()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	attachmentKeys()	Returns any attachment vfs keys for this entry.
long	attributes()	The attribute flags for this entry
JournalEntry	attributes(long attributes)	Sets the attribute flags for this entry
int	cardinal()	The cardinal entry number for the journal entry.
JournalEntry	cardinal(int cardinal)	Sets the cardinal entry number for the journal entry.
int	compareTo(JournalEntry o)	Compares two journal entry objects to each other
int	compareTo(CMObject 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()	The "image path" or, for mailboxes, the Journal Name this mail served as a source for.
JournalEntry	data(java.lang.String data)	Sets the "image path" or, for mailboxes, the Journal Name this mail served as a source for.
long	date()	The date/time, in ms, that the message was posted
protected JournalEntry	date(long date)
java.lang.String	dateStr()	The date/time, in ms, coded, or "", that the message was posted
JournalEntry	dateStr(java.lang.String date)	Sets the date/time, in ms, coded, or "", that the message was posted
java.lang.StringBuffer	derivedBuildMessage()	The friendly viewable form of this message in the command line.
JournalEntry	derivedBuildMessage(java.lang.StringBuffer msg)	The friendly viewable form of this message in the command line.
long	expiration()	The date/time, in ms, that the message will expire
JournalEntry	expiration(long expiration)	Sets the date/time, in ms, that the message will expire
java.lang.String	from()	The author of the entry
JournalEntry	from(java.lang.String from)	Sets the author of the entry
TimeClock	getKnownClock()	If the dateStr for this message was set as an in-game clock, then this will attempt to derive the specific clock used and then return it.
java.lang.String	getXML()	Returns an xml representation of this entry.
int	hashCode()
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()	Returns whether this is the last entry in the db.
java.lang.String	key()	The fully unique key for this entry, unique across all entries in all books and journals
JournalEntry	key(java.lang.String key)	Sets the fully unique key for this entry, unique across all entries in all books and journals
JournalEntry	lastEntry(boolean lastEntry)	Sets whether this is the last entry in the db
java.lang.String	msg()	The content of the entry.
JournalEntry	msg(java.lang.String msg)	Sets the content of the entry.
java.lang.String	msgIcon()	The image icon for forum entries
JournalEntry	msgIcon(java.lang.String msgIcon)	Sets the image icon for forum entries
java.lang.String	name()	The displayable name of this object.
CMObject	newInstance()	Returns a new instance of this class.
java.lang.String	parent()	The entry key of the entry that this entry is a reply to
JournalEntry	parent(java.lang.String parent)	Sets the entry key of the entry that this entry is a reply to
int	replies()	The number of replies to this entry.
JournalEntry	replies(int replies)	Sets he number of replies to this entry.
void	setXML(java.lang.String xml)	Sets an entry based on the given xml.
java.lang.String	subj()	The subject of the entry
JournalEntry	subj(java.lang.String subj)	Sets the subject of the entry
java.lang.String	to()	Who the entry is for, usually ALL
JournalEntry	to(java.lang.String to)	Sets who the entry is for, usually ALL
long	update()	The date/time, in ms, that the message was updated
JournalEntry	update(long update)	Sets the date/time, in ms, that the message was updated
int	views()	The number of views of this entry
JournalEntry	views(int views)	Sets the number of views of this entry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, 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

dateStr

public java.lang.String dateStr

date

public long date

update

public long update

expiration

public long expiration

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

hashCode

public int hashCode

isLastEntry

public boolean isLastEntry

attachments

public java.util.List<java.lang.String> attachments

derivedBuildMessage

public java.lang.StringBuffer derivedBuildMessage

knownClockName

protected java.lang.String knownClockName

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

Description copied from interface: JournalEntry

The fully unique key for this entry, unique across all entries in all books and journals

Specified by:

key in interface JournalEntry

Returns:

the key

key

public JournalEntry key(java.lang.String key)

Description copied from interface: JournalEntry

Sets the fully unique key for this entry, unique across all entries in all books and journals

Specified by:

key in interface JournalEntry

Parameters:

key - the key

Returns:

the journal entry

from

public java.lang.String from()

Description copied from interface: JournalEntry

The author of the entry

Specified by:

from in interface JournalEntry

Returns:

author of the entry

from

public JournalEntry from(java.lang.String from)

Description copied from interface: JournalEntry

Sets the author of the entry

Specified by:

from in interface JournalEntry

Parameters:

from - author of the entry

Returns:

the journal entry

to

public java.lang.String to()

Description copied from interface: JournalEntry

Who the entry is for, usually ALL

Specified by:

to in interface JournalEntry

Returns:

who the entry is for, usually ALL

to

public JournalEntry to(java.lang.String to)

Description copied from interface: JournalEntry

Sets who the entry is for, usually ALL

Specified by:

to in interface JournalEntry

Parameters:

to - who the entry is for, usually ALL

Returns:

the journal entry

subj

public java.lang.String subj()

Description copied from interface: JournalEntry

The subject of the entry

Specified by:

subj in interface JournalEntry

Returns:

the subject of the entry

subj

public JournalEntry subj(java.lang.String subj)

Description copied from interface: JournalEntry

Sets the subject of the entry

Specified by:

subj in interface JournalEntry

Parameters:

subj - the subject of the entry

Returns:

the journal entry

msg

public java.lang.String msg()

Description copied from interface: JournalEntry

The content of the entry.

Specified by:

msg in interface JournalEntry

Returns:

the content of the entry.

msg

public JournalEntry msg(java.lang.String msg)

Description copied from interface: JournalEntry

Sets the content of the entry.

Specified by:

msg in interface JournalEntry

Parameters:

msg - the content of the entry.

Returns:

the journal entry

date

public long date()

Description copied from interface: JournalEntry

The date/time, in ms, that the message was posted

Specified by:

date in interface JournalEntry

Returns:

the date/time, in ms, that the message was posted

date

protected JournalEntry date(long date)

dateStr

public java.lang.String dateStr()

Description copied from interface: JournalEntry

The date/time, in ms, coded, or "", that the message was posted

Specified by:

dateStr in interface JournalEntry

Returns:

the date/time, in ms, coded, or "", that the message was posted

dateStr

public JournalEntry dateStr(java.lang.String date)

Description copied from interface: JournalEntry

Sets the date/time, in ms, coded, or "", that the message was posted

Specified by:

dateStr in interface JournalEntry

Parameters:

date - the date/time, in ms, coded, or "", that the message was posted

Returns:

the journal entry

getKnownClock

public TimeClock getKnownClock()

Description copied from interface: JournalEntry

If the dateStr for this message was set as an in-game clock, then this will attempt to derive the specific clock used and then return it.

Specified by:

getKnownClock in interface JournalEntry

Returns:

the clock derived from dateStr, or null

update

public long update()

Description copied from interface: JournalEntry

The date/time, in ms, that the message was updated

Specified by:

update in interface JournalEntry

Returns:

the date/time, in ms, that the message was updated

update

public JournalEntry update(long update)

Description copied from interface: JournalEntry

Sets the date/time, in ms, that the message was updated

Specified by:

update in interface JournalEntry

Parameters:

update - the date/time, in ms, that the message was updated

Returns:

the journal entry

expiration

public long expiration()

Description copied from interface: JournalEntry

The date/time, in ms, that the message will expire

Specified by:

expiration in interface JournalEntry

Returns:

the date/time, in ms, that the message will expire

expiration

public JournalEntry expiration(long expiration)

Description copied from interface: JournalEntry

Sets the date/time, in ms, that the message will expire

Specified by:

expiration in interface JournalEntry

Parameters:

expiration - the date/time, in ms, that the message will expire

Returns:

the journal entry

parent

public java.lang.String parent()

Description copied from interface: JournalEntry

The entry key of the entry that this entry is a reply to

Specified by:

parent in interface JournalEntry

Returns:

the entry key of the entry that this entry is a reply to

parent

public JournalEntry parent(java.lang.String parent)

Description copied from interface: JournalEntry

Sets the entry key of the entry that this entry is a reply to

Specified by:

parent in interface JournalEntry

Parameters:

parent - the entry key of the entry that this entry is a reply to

Returns:

the journal entry

attributes

public long attributes()

Description copied from interface: JournalEntry

The attribute flags for this entry

Specified by:

attributes in interface JournalEntry

Returns:

the attribute flags for this entry

attributes

public JournalEntry attributes(long attributes)

Description copied from interface: JournalEntry

Sets the attribute flags for this entry

Specified by:

attributes in interface JournalEntry

Parameters:

attributes - the attribute flags for this entry

Returns:

the journal entry

data

public java.lang.String data()

Description copied from interface: JournalEntry

The "image path" or, for mailboxes, the Journal Name this mail served as a source for.

Specified by:

data in interface JournalEntry

Returns:

the "image path" or, for mailboxes, the Journal Name this mail served as a source for.

data

public JournalEntry data(java.lang.String data)

Description copied from interface: JournalEntry

Sets the "image path" or, for mailboxes, the Journal Name this mail served as a source for.

Specified by:

data in interface JournalEntry

Parameters:

data - the "image path" or, for mailboxes, the Journal Name this mail served as a source for.

Returns:

the journal entry

cardinal

public int cardinal()

Description copied from interface: JournalEntry

The cardinal entry number for the journal entry.

Specified by:

cardinal in interface JournalEntry

Returns:

the cardinal entry number for the journal entry.

cardinal

public JournalEntry cardinal(int cardinal)

Description copied from interface: JournalEntry

Sets the cardinal entry number for the journal entry.

Specified by:

cardinal in interface JournalEntry

Parameters:

cardinal - the cardinal entry number for the journal entry.

Returns:

the journal entry

msgIcon

public java.lang.String msgIcon()

Description copied from interface: JournalEntry

The image icon for forum entries

Specified by:

msgIcon in interface JournalEntry

Returns:

the image icon for forum entries

msgIcon

public JournalEntry msgIcon(java.lang.String msgIcon)

Description copied from interface: JournalEntry

Sets the image icon for forum entries

Specified by:

msgIcon in interface JournalEntry

Parameters:

msgIcon - the image icon for forum entries

Returns:

the journal entry

replies

public int replies()

Description copied from interface: JournalEntry

The number of replies to this entry.

Specified by:

replies in interface JournalEntry

Returns:

the number of replies to this entry.

replies

public JournalEntry replies(int replies)

Description copied from interface: JournalEntry

Sets he number of replies to this entry.

Specified by:

replies in interface JournalEntry

Parameters:

replies - the number of replies to this entry.

Returns:

the journal entry

views

public int views()

Description copied from interface: JournalEntry

The number of views of this entry

Specified by:

views in interface JournalEntry

Returns:

the number of views of this entry

views

public JournalEntry views(int views)

Description copied from interface: JournalEntry

Sets the number of views of this entry

Specified by:

views in interface JournalEntry

Parameters:

views - the number of views of this entry

Returns:

the journal entry

attachmentKeys

public java.util.List<java.lang.String> attachmentKeys()

Description copied from interface: JournalEntry

Returns any attachment vfs keys for this entry.

Specified by:

attachmentKeys in interface JournalEntry

Returns:

any attachment vfs keys for this entry.

isLastEntry

public boolean isLastEntry()

Description copied from interface: JournalEntry

Returns whether this is the last entry in the db. This is not actually stored in the DB, but is derived from the reading process.

Specified by:

isLastEntry in interface JournalEntry

Returns:

whether this is the last entry in the db

lastEntry

public JournalEntry lastEntry(boolean lastEntry)

Description copied from interface: JournalEntry

Sets whether this is the last entry in the db

Specified by:

lastEntry in interface JournalEntry

Parameters:

lastEntry - whether this is the last entry in the db

Returns:

the journal entry

derivedBuildMessage

public java.lang.StringBuffer derivedBuildMessage()

Description copied from interface: JournalEntry

The friendly viewable form of this message in the command line. Is not included in any xml builds or in the DB.

Specified by:

derivedBuildMessage in interface JournalEntry

Returns:

the friendly message

derivedBuildMessage

public JournalEntry derivedBuildMessage(java.lang.StringBuffer msg)

Description copied from interface: JournalEntry

The friendly viewable form of this message in the command line. Is not included in any xml builds or in the DB.

Specified by:

derivedBuildMessage in interface JournalEntry

Parameters:

msg - the friendly message

Returns:

the journal entry

compareTo

public int compareTo(JournalEntry o)

Description copied from interface: JournalEntry

Compares two journal entry objects to each other

Specified by:

compareTo in interface JournalEntry

Parameters:

o - another journal entry obj

Returns:

true or false

getXML

public java.lang.String getXML()

Description copied from interface: JournalEntry

Returns an xml representation of this entry.

Specified by:

getXML in interface JournalEntry

Returns:

an xml representation of this entry

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setXML

public void setXML(java.lang.String xml)

Description copied from interface: JournalEntry

Sets an entry based on the given xml.

Specified by:

setXML in interface JournalEntry

Parameters:

xml - the xml to use.

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 CMObject

Specified by:

copyOf in interface JournalEntry

Returns:

a clone of this object