Package com.planet_ink.coffee_mud.Common.interfaces

Interface JournalEntry

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

DefaultJournalEntry

public interface JournalEntry
extends CMCommon, java.lang.Cloneable

An entry in a journal or book

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JournalEntry.JournalAttrib

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

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
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
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 update)	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.
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	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 interface com.planet_ink.coffee_mud.core.interfaces.CMObject

ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

key

java.lang.String key()

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

Returns:

the key

key

JournalEntry key(java.lang.String key)

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

Parameters:

key - the key

Returns:

the journal entry

from

java.lang.String from()

The author of the entry

Returns:

author of the entry

from

JournalEntry from(java.lang.String from)

Sets the author of the entry

Parameters:

from - author of the entry

Returns:

the journal entry

to

java.lang.String to()

Who the entry is for, usually ALL

Returns:

who the entry is for, usually ALL

to

JournalEntry to(java.lang.String to)

Sets who the entry is for, usually ALL

Parameters:

to - who the entry is for, usually ALL

Returns:

the journal entry

subj

java.lang.String subj()

The subject of the entry

Returns:

the subject of the entry

subj

JournalEntry subj(java.lang.String subj)

Sets the subject of the entry

Parameters:

subj - the subject of the entry

Returns:

the journal entry

msg

java.lang.String msg()

The content of the entry.

Returns:

the content of the entry.

msg

JournalEntry msg(java.lang.String msg)

Sets the content of the entry.

Parameters:

msg - the content of the entry.

Returns:

the journal entry

date

long date()

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

Returns:

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

getKnownClock

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.

Returns:

the clock derived from dateStr, or null

dateStr

java.lang.String dateStr()

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

Returns:

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

dateStr

JournalEntry dateStr(java.lang.String date)

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

Parameters:

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

Returns:

the journal entry

update

long update()

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

Returns:

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

update

JournalEntry update(long update)

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

Parameters:

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

Returns:

the journal entry

expiration

long expiration()

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

Returns:

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

expiration

JournalEntry expiration(long update)

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

Parameters:

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

Returns:

the journal entry

parent

java.lang.String parent()

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

Returns:

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

parent

JournalEntry parent(java.lang.String parent)

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

Parameters:

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

Returns:

the journal entry

attributes

long attributes()

The attribute flags for this entry

Returns:

the attribute flags for this entry

attributes

JournalEntry attributes(long attributes)

Sets the attribute flags for this entry

Parameters:

attributes - the attribute flags for this entry

Returns:

the journal entry

data

java.lang.String data()

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

Returns:

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

data

JournalEntry data(java.lang.String data)

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

Parameters:

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

Returns:

the journal entry

cardinal

int cardinal()

The cardinal entry number for the journal entry.

Returns:

the cardinal entry number for the journal entry.

cardinal

JournalEntry cardinal(int cardinal)

Sets the cardinal entry number for the journal entry.

Parameters:

cardinal - the cardinal entry number for the journal entry.

Returns:

the journal entry

msgIcon

java.lang.String msgIcon()

The image icon for forum entries

Returns:

the image icon for forum entries

msgIcon

JournalEntry msgIcon(java.lang.String msgIcon)

Sets the image icon for forum entries

Parameters:

msgIcon - the image icon for forum entries

Returns:

the journal entry

replies

int replies()

The number of replies to this entry.

Returns:

the number of replies to this entry.

replies

JournalEntry replies(int replies)

Sets he number of replies to this entry.

Parameters:

replies - the number of replies to this entry.

Returns:

the journal entry

views

int views()

The number of views of this entry

Returns:

the number of views of this entry

views

JournalEntry views(int views)

Sets the number of views of this entry

Parameters:

views - the number of views of this entry

Returns:

the journal entry

isLastEntry

boolean isLastEntry()

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.

Returns:

whether this is the last entry in the db

lastEntry

JournalEntry lastEntry(boolean lastEntry)

Sets whether this is the last entry in the db

Parameters:

lastEntry - whether this is the last entry in the db

Returns:

the journal entry

derivedBuildMessage

java.lang.StringBuffer derivedBuildMessage()

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

Returns:

the friendly message

derivedBuildMessage

JournalEntry derivedBuildMessage(java.lang.StringBuffer msg)

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

Parameters:

msg - the friendly message

Returns:

the journal entry

compareTo

int compareTo(JournalEntry o)

Compares two journal entry objects to each other

Parameters:

o - another journal entry obj

Returns:

true or false

getXML

java.lang.String getXML()

Returns an xml representation of this entry.

Returns:

an xml representation of this entry

setXML

void setXML(java.lang.String xml)

Sets an entry based on the given xml.

Parameters:

xml - the xml to use.

attachmentKeys

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

Returns any attachment vfs keys for this entry.

Returns:

any attachment vfs keys for this entry.

copyOf

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

Returns:

a clone of this object