Package com.planet_ink.coffee_mud.Libraries.interfaces

Enum JournalsLibrary.CommandJournalFlags

java.lang.Object

java.lang.Enum<JournalsLibrary.CommandJournalFlags>

com.planet_ink.coffee_mud.Libraries.interfaces.JournalsLibrary.CommandJournalFlags

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JournalsLibrary.CommandJournalFlags>

Enclosing interface:

JournalsLibrary

public static enum JournalsLibrary.CommandJournalFlags
extends java.lang.Enum<JournalsLibrary.CommandJournalFlags>

This enum defines flags that apply to command journals.

See Also:

JournalsLibrary.CommandJournal

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDROOM	Include the journalers current room in the message
ADMINECHO	Echo messages to this journal to the privileged folk.
ASSIGN	Arbitrary transfer targets for admins
CHANNEL	Echo messages to this journal to the given Channel
CONFIRM	Require user confirmation before completing a post.
EXPIRE	How old before a message is auto-purged
MOTD	Read the journal at logon
REPLYALL	Journal, ALL, or user to send message to when replying to messages sent to ALL
REPLYSELF	Journal, ALL, or user to send message to when replying to message to/from the user.
SCRIPT	Path to mobprog script to run when trying to post to this

Method Summary

Modifier and Type	Method	Description
static JournalsLibrary.CommandJournalFlags	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static JournalsLibrary.CommandJournalFlags[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHANNEL

public static final JournalsLibrary.CommandJournalFlags CHANNEL

Echo messages to this journal to the given Channel

ADDROOM

public static final JournalsLibrary.CommandJournalFlags ADDROOM

Include the journalers current room in the message

EXPIRE

public static final JournalsLibrary.CommandJournalFlags EXPIRE

How old before a message is auto-purged

ADMINECHO

public static final JournalsLibrary.CommandJournalFlags ADMINECHO

Echo messages to this journal to the privileged folk.

CONFIRM

public static final JournalsLibrary.CommandJournalFlags CONFIRM

Require user confirmation before completing a post.

SCRIPT

public static final JournalsLibrary.CommandJournalFlags SCRIPT

Path to mobprog script to run when trying to post to this

REPLYSELF

public static final JournalsLibrary.CommandJournalFlags REPLYSELF

Journal, ALL, or user to send message to when replying to message to/from the user.

REPLYALL

public static final JournalsLibrary.CommandJournalFlags REPLYALL

Journal, ALL, or user to send message to when replying to messages sent to ALL

MOTD

public static final JournalsLibrary.CommandJournalFlags MOTD

Read the journal at logon

ASSIGN

public static final JournalsLibrary.CommandJournalFlags ASSIGN

Arbitrary transfer targets for admins

Method Detail

values

public static JournalsLibrary.CommandJournalFlags[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JournalsLibrary.CommandJournalFlags c : JournalsLibrary.CommandJournalFlags.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JournalsLibrary.CommandJournalFlags valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null