Package com.planet_ink.coffee_mud.Items.Basic

Class StdJournal

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Basic.StdJournal

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Book, Item, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

ArchonJournal, GenJournal

public class StdJournal
extends StdItem
implements Book

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	lastDateRead
protected MOB	lastReadTo
protected java.util.Map<java.lang.String,java.lang.String>	parmCache

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
StdJournal()

Method Summary

Modifier and Type	Method	Description
void	addRawContent(java.lang.String authorName, java.lang.String content)	Adds a page to this book, or appends content if just a piece of paper.
boolean	canRead(MOB mob)	Returns whether the content is readable by the given mob/player.
boolean	canWrite(MOB mob)	Returns whether this can be written to by the given mob/player
protected boolean	completeTransfer(MOB mob, CMMsg msg, java.lang.String journal, JournalEntry entry2, boolean transfer)
JournalEntry	DBRead(MOB reader, java.lang.String journal, int which, long lastTimeDate, boolean newOnly, boolean all)
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
java.lang.String	genericName()	Returns a generic name for this object, devoid of its particular identifying details.
java.lang.String	getContent(int page)	Returns the readable content of a page
int	getMaxCharsPerPage()	Returns the maximum number of chars that can be written on each page in this book.
int	getMaxPages()	Returns the maximum number of pages that can be written on in this book.
JournalsLibrary.CommandJournal	getMyCommandJournal()
java.lang.String	getRawContent(int page)	Returns the raw content of a page
protected java.lang.String	getReadFilter()
protected java.lang.String	getReadReq()
int	getUsedPages()	Returns the number of pages with writing on them.
protected java.lang.String	getWriteReq()
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isJournal()	Returns whether the content is shared among all similar items, or is unique to this item or owner or a special key.
boolean	okMessage(Environmental myHost, CMMsg msg)	The general message event previewer for the object.
void	recoverPhyStats()	This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method.
void	setMaxCharsPerPage(int max)	Sets the maximum number of chars that can be written on each page in this book.
void	setMaxPages(int max)	Sets the maximum number of pages that can be written on in this book.
void	setReadableText(java.lang.String text)	For things that are readable, this set the readable string for this thing.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Affectable

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, setBasePhyStats

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Contingent

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Environmental

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Expireable

expirationDate, setExpirationDate

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Physical

description, displayText, name

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable

isReadable, readableText, setReadable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.StatsAffecting

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getStat, getStatCodes, getTickStatus, I, image, initializeClass, isGeneric, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, riding, sameAs, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setMiscText, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

getTickStatus, name, tick

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

lastReadTo

protected MOB lastReadTo

lastDateRead

protected long[] lastDateRead

parmCache

protected java.util.Map<java.lang.String,java.lang.String> parmCache

Constructor Detail

StdJournal

public StdJournal()

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

Overrides:

ID in class StdItem

Returns:

the name of this class

genericName

public java.lang.String genericName()

Description copied from interface: Physical

Returns a generic name for this object, devoid of its particular identifying details. e.g. for a mob, this would return the age-range and race of this mob, as if it were someone spotted on the street that you didn't know.

Specified by:

genericName in interface Physical

Overrides:

genericName in class StdItem

Returns:

the generic name of this thing

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()

canRead

public boolean canRead(MOB mob)

Description copied from interface: Book

Returns whether the content is readable by the given mob/player.

Specified by:

canRead in interface Book

Parameters:

mob - the mob/player to check

Returns:

true if this journal item can be read by that mob/player

canWrite

public boolean canWrite(MOB mob)

Description copied from interface: Book

Returns whether this can be written to by the given mob/player

Specified by:

canWrite in interface Book

Parameters:

mob - the mob/player to check

Returns:

true if this journal item can be written to by that mob/player

completeTransfer

protected boolean completeTransfer(MOB mob,
                                   CMMsg msg,
                                   java.lang.String journal,
                                   JournalEntry entry2,
                                   boolean transfer)

getMyCommandJournal

public JournalsLibrary.CommandJournal getMyCommandJournal()

setReadableText

public void setReadableText(java.lang.String text)

Description copied from interface: Readable

For things that are readable, this set the readable string for this thing. That is to say, what the player sees when they read the door.

Specified by:

setReadableText in interface Readable

Overrides:

setReadableText in class StdItem

Parameters:

text - the readable text

See Also:

Readable.isReadable(), Readable.setReadable(boolean), Readable.readableText()

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class StdItem

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that needs to be executed

See Also:

CMMsg

DBRead

public JournalEntry DBRead(MOB reader,
                           java.lang.String journal,
                           int which,
                           long lastTimeDate,
                           boolean newOnly,
                           boolean all)

getReadReq

protected java.lang.String getReadReq()

getReadFilter

protected java.lang.String getReadFilter()

getWriteReq

protected java.lang.String getWriteReq()

getUsedPages

public int getUsedPages()

Description copied from interface: Book

Returns the number of pages with writing on them.

Specified by:

getUsedPages in interface Book

Returns:

the number of pages with writing on them.

See Also:

Book.getContent(int), Book.getRawContent(int), Book.getMaxPages()

getMaxPages

public int getMaxPages()

Description copied from interface: Book

Returns the maximum number of pages that can be written on in this book. 0 means infinite.

Specified by:

getMaxPages in interface Book

Returns:

the maximum number of pages that can be written on

See Also:

Book.setMaxPages(int), Book.getUsedPages()

getMaxCharsPerPage

public int getMaxCharsPerPage()

Description copied from interface: Book

Returns the maximum number of chars that can be written on each page in this book. 0 means infinite.

Specified by:

getMaxCharsPerPage in interface Book

Returns:

the maximum number of chars that can be written on

See Also:

Book.setMaxCharsPerPage(int)

setMaxCharsPerPage

public void setMaxCharsPerPage(int max)

Description copied from interface: Book

Sets the maximum number of chars that can be written on each page in this book. 0 means infinite.

Specified by:

setMaxCharsPerPage in interface Book

Parameters:

max - the maximum number of pages that can be written on

See Also:

Book.getMaxCharsPerPage()

setMaxPages

public void setMaxPages(int max)

Description copied from interface: Book

Sets the maximum number of pages that can be written on in this book. 0 means infinite.

Specified by:

setMaxPages in interface Book

Parameters:

max - the maximum number of pages that can be written on

See Also:

Book.getMaxPages()

getRawContent

public java.lang.String getRawContent(int page)

Description copied from interface: Book

Returns the raw content of a page

Specified by:

getRawContent in interface Book

Parameters:

page - the page number, 1-N

Returns:

the raw content of a page

See Also:

Book.getContent(int), Book.getUsedPages()

getContent

public java.lang.String getContent(int page)

Description copied from interface: Book

Returns the readable content of a page

Specified by:

getContent in interface Book

Parameters:

page - the page number, 1-N

Returns:

the readable content of a page

See Also:

Book.getRawContent(int), Book.getUsedPages()

addRawContent

public void addRawContent(java.lang.String authorName,
                          java.lang.String content)

Description copied from interface: Book

Adds a page to this book, or appends content if just a piece of paper.

Specified by:

addRawContent in interface Book

Parameters:

authorName - the name of the author, which might not be used

content - the content, with subject surrounded by "::" as first chars, optional

See Also:

Book.getRawContent(int), Book.getUsedPages()

isJournal

public boolean isJournal()

Description copied from interface: Book

Returns whether the content is shared among all similar items, or is unique to this item or owner or a special key.

Specified by:

isJournal in interface Book

Returns:

true if it is shared, false otherwise

recoverPhyStats

public void recoverPhyStats()

Description copied from interface: Affectable

This method copies the basePhyStats() object into the phyStats() object, then makes repeated calls to all surrounding objects with affectPhyStats(Environmental,PhyStats) method. Surrounding objects include the room where the object is located, the Ability objects in the Effects list, the Behaviors in the behaviors list, and race/charclass/area if applicable. Those methods will then make all necessary adjustments to the values in the new phyStats() object. When it returns, phyStats() will have a totally updated object. This method must be called in code whenever the object is placed on the map, or when anything changes in its environment, such as location, effects, or other states.

Specified by:

recoverPhyStats in interface Affectable

Overrides:

recoverPhyStats in class StdItem

See Also:

Affectable.basePhyStats(), Affectable.phyStats(), Affectable.addEffect(Ability), Behavable.addBehavior(Behavior), PhyStats