com.planet_ink.coffee_mud.Libraries
Class CMJournals

java.lang.Object
  com.planet_ink.coffee_mud.Libraries.StdLibrary
      com.planet_ink.coffee_mud.Libraries.CMJournals

All Implemented Interfaces:

CMObject, CMLibrary, JournalsLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>, java.lang.Runnable

public class CMJournals
extends StdLibrary
implements JournalsLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.JournalsLibrary

JournalsLibrary.CommandJournal, JournalsLibrary.CommandJournalFlags, JournalsLibrary.ForumJournal, JournalsLibrary.ForumJournalFlags, JournalsLibrary.JournalEntry, JournalsLibrary.JournalSummaryStats

Field Summary

protected SHashtable<java.lang.String,JournalsLibrary.CommandJournal>	commandJournals
java.util.Vector	emptyVector
protected SHashtable<java.lang.String,JournalsLibrary.ForumJournal>	forumJournals
int	QUEUE_SIZE

Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.JournalsLibrary

JOURNAL_BOUNDARY

Constructor Summary

CMJournals()

Method Summary

boolean	activate()
boolean	canReadMessage(JournalsLibrary.JournalEntry entry, java.lang.String srchMatch, MOB readerM, boolean ignorePrivileges)
void	clearJournalSummaryStats(java.lang.String journalName)
java.util.Enumeration<JournalsLibrary.CommandJournal>	commandJournals()
void	expirationJournalSweep()
java.util.Enumeration<JournalsLibrary.ForumJournal>	forumJournals()
java.util.HashSet<java.lang.String>	getArchonJournalNames()
JournalsLibrary.CommandJournal	getCommandJournal(java.lang.String named)
JournalsLibrary.ForumJournal	getForumJournal(java.lang.String named)
JournalsLibrary.JournalSummaryStats	getJournalStats(java.lang.String journalName)
int	getNumCommandJournals()
int	getNumForumJournals()
java.lang.String	getScriptValue(MOB mob, java.lang.String journal, java.lang.String oldValue)
protected java.util.Hashtable<java.lang.String,JournalsLibrary.JournalSummaryStats>	getSummaryStats()
ThreadEngine.SupportThread	getSupportThread()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isArchonJournalName(java.lang.String journal)
int	loadCommandJournals(java.lang.String list)
int	loadForumJournals(java.lang.String list)
void	run()
boolean	shutdown()

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

compareTo, copyOf, initializeClass, newInstance, propertiesLoaded

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.Libraries.interfaces.CMLibrary

propertiesLoaded

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

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

QUEUE_SIZE

public final int QUEUE_SIZE

See Also:

Constant Field Values

commandJournals

protected SHashtable<java.lang.String,JournalsLibrary.CommandJournal> commandJournals

forumJournals

protected SHashtable<java.lang.String,JournalsLibrary.ForumJournal> forumJournals

emptyVector

public final java.util.Vector emptyVector

Constructor Detail

CMJournals

public CMJournals()

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

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getSupportThread

public ThreadEngine.SupportThread getSupportThread()

Specified by:

getSupportThread in interface CMLibrary

Overrides:

getSupportThread in class StdLibrary

getSummaryStats

protected java.util.Hashtable<java.lang.String,JournalsLibrary.JournalSummaryStats> getSummaryStats()

getJournalStats

public JournalsLibrary.JournalSummaryStats getJournalStats(java.lang.String journalName)

Specified by:

getJournalStats in interface JournalsLibrary

clearJournalSummaryStats

public void clearJournalSummaryStats(java.lang.String journalName)

Specified by:

clearJournalSummaryStats in interface JournalsLibrary

loadCommandJournals

public int loadCommandJournals(java.lang.String list)

Specified by:

loadCommandJournals in interface JournalsLibrary

canReadMessage

public boolean canReadMessage(JournalsLibrary.JournalEntry entry,
                              java.lang.String srchMatch,
                              MOB readerM,
                              boolean ignorePrivileges)

Specified by:

canReadMessage in interface JournalsLibrary

loadForumJournals

public int loadForumJournals(java.lang.String list)

Specified by:

loadForumJournals in interface JournalsLibrary

getArchonJournalNames

public java.util.HashSet<java.lang.String> getArchonJournalNames()

Specified by:

getArchonJournalNames in interface JournalsLibrary

isArchonJournalName

public boolean isArchonJournalName(java.lang.String journal)

Specified by:

isArchonJournalName in interface JournalsLibrary

getScriptValue

public java.lang.String getScriptValue(MOB mob,
                                       java.lang.String journal,
                                       java.lang.String oldValue)

Specified by:

getScriptValue in interface JournalsLibrary

getNumCommandJournals

public int getNumCommandJournals()

Specified by:

getNumCommandJournals in interface JournalsLibrary

commandJournals

public java.util.Enumeration<JournalsLibrary.CommandJournal> commandJournals()

Specified by:

commandJournals in interface JournalsLibrary

getCommandJournal

public JournalsLibrary.CommandJournal getCommandJournal(java.lang.String named)

Specified by:

getCommandJournal in interface JournalsLibrary

expirationJournalSweep

public void expirationJournalSweep()

activate

public boolean activate()

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

getNumForumJournals

public int getNumForumJournals()

Specified by:

getNumForumJournals in interface JournalsLibrary

forumJournals

public java.util.Enumeration<JournalsLibrary.ForumJournal> forumJournals()

Specified by:

forumJournals in interface JournalsLibrary

getForumJournal

public JournalsLibrary.ForumJournal getForumJournal(java.lang.String named)

Specified by:

getForumJournal in interface JournalsLibrary

shutdown

public boolean shutdown()

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

run

public void run()

Specified by:

run in interface java.lang.Runnable