biz.massivedynamics.modger.message

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

biz.massivedynamics.modger.message.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>

public enum MessageType
extends Enum<MessageType>

An enumeration that defines message types

Since:

1.0.0.0

Author:

Cruz Bishop

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Data used when debugging; This is not usually needed by a user
ERROR An error, required when something goes wrong
INFORMATION Information that is not as important as regular output, but may be used by a normal user
REGULAR Regular output; The equivalent of System.out.println
TRACE Trace-level data that is rarely needed except in deep debugging
WARNING A warning; Useful for users to know in case they must stop doing something

Method Summary

Methods

Modifier and Type	Method and Description
void	filter() Filters this message type
boolean	isFiltered() Checks to see if this message type is filtered
void	unfilter() Unfilters this message type
static MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageType[]	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

TRACE

public static final MessageType TRACE

Trace-level data that is rarely needed except in deep debugging

DEBUG

public static final MessageType DEBUG

Data used when debugging; This is not usually needed by a user

INFORMATION

public static final MessageType INFORMATION

Information that is not as important as regular output, but may be used by a normal user

REGULAR

public static final MessageType REGULAR

Regular output; The equivalent of System.out.println

WARNING

public static final MessageType WARNING

A warning; Useful for users to know in case they must stop doing something

ERROR

public static final MessageType ERROR

An error, required when something goes wrong

Method Detail

values

public static MessageType[] 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 (MessageType c : MessageType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MessageType valueOf(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:

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

NullPointerException - if the argument is null

isFiltered

public boolean isFiltered()

Checks to see if this message type is filtered

Returns:

The filtered status

Since:

1.0.0.0

filter

public void filter()

Filters this message type

Since:

1.0.0.0

unfilter

public void unfilter()

Unfilters this message type

Since:

1.0.0.0