Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface JournalsLibrary.CommandJournal

Enclosing interface:

JournalsLibrary

public static interface JournalsLibrary.CommandJournal

Command Journals are another category of Journal that is accessed from the command line (as oppposed to SMTP Journals accessed via email, Forums accessed via web page, and standard Journal accessed via item). Examples of a command journal are things like the BUG or TYPO command.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFlag(JournalsLibrary.CommandJournalFlags flag)	Returns the value of a give journal flag
java.lang.String	getScriptFilename()	Returns the same as getFlag(SCRIPT);
java.lang.String	JOURNAL_NAME()	Returns the name of the journal in the database.
java.lang.String	mask()	Returns the ZapperMask for posting to the journal
java.lang.String	NAME()	Returns the name of the journal, as well as the command word

Method Detail

NAME

java.lang.String NAME()

Returns the name of the journal, as well as the command word

Returns:

the name of the journal, as well as the command word

mask

java.lang.String mask()

Returns the ZapperMask for posting to the journal

Returns:

the ZapperMask for posting to the journal

JOURNAL_NAME

java.lang.String JOURNAL_NAME()

Returns the name of the journal in the database. SYSTEM_*

Returns:

the name of the journal in the database. SYSTEM_*

getFlag

java.lang.String getFlag(JournalsLibrary.CommandJournalFlags flag)

Returns the value of a give journal flag

Parameters:

flag - the flag

Returns:

the value of a give journal flag, or null

See Also:

JournalsLibrary.CommandJournalFlags

getScriptFilename

java.lang.String getScriptFilename()

Returns the same as getFlag(SCRIPT);

Returns:

the same as getFlag(SCRIPT);

See Also:

getFlag(CommandJournalFlags)