org.josef.util

Class Message

java.lang.Object

org.josef.util.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

Abstraction of a localizable message.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.josef.util.Message.MessageType	DEBUG A debug message.
static org.josef.util.Message.MessageType	ERROR An error message.
static org.josef.util.Message.MessageType	FATAL A fatal error message.
static org.josef.util.Message.MessageType	INFO An informational message.
static org.josef.util.Message.MessageType	WARNING A warning.

Constructor Summary

Constructors

Constructor and Description
Message(org.josef.util.Message.MessageType type, CResourceBundle resourceBundle, String messageKey, Object... messageArguments) Constructs a message of the supplied type from the supplied resourceBundle, messageKey and optional messageArguments.
Message(org.josef.util.Message.MessageType type, String message) Constructs a message of the supplied type, using the supplied (localized) message.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets the localized message.
org.josef.util.Message.MessageType	getType() Gets the type of message.
String	toString() Creates a String representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final org.josef.util.Message.MessageType DEBUG

A debug message.

INFO

public static final org.josef.util.Message.MessageType INFO

An informational message.

WARNING

public static final org.josef.util.Message.MessageType WARNING

A warning.

ERROR

public static final org.josef.util.Message.MessageType ERROR

An error message.

FATAL

public static final org.josef.util.Message.MessageType FATAL

A fatal error message.

Constructor Detail

Message

public Message(org.josef.util.Message.MessageType type,
               CResourceBundle resourceBundle,
               String messageKey,
               Object... messageArguments)

Constructs a message of the supplied type from the supplied resourceBundle, messageKey and optional messageArguments.

Parameters:

type - Message type.

resourceBundle - Resource bundle containing the message.

messageKey - Key to the resource bundle.

messageArguments - Optional Message arguments that are substituted in the retrieved String resource.

Throws:

IllegalArgumentException - When the supplied messageKey is empty.

NullPointerException - When either the supplied type, resourceBundle or messageKey is null.

Message

public Message(org.josef.util.Message.MessageType type,
               String message)

Constructs a message of the supplied type, using the supplied (localized) message.

Parameters:

type - Message type.

message - The (localized) message.

Throws:

IllegalArgumentException - When the supplied message is empty.

NullPointerException - When either the supplied type or message is null.

Method Detail

getType

public org.josef.util.Message.MessageType getType()

Gets the type of message.

Returns:

Message type.

getMessage

public String getMessage()

Gets the localized message.

Returns:

The localized message.

toString

public String toString()

Creates a String representation of this object.

Overrides:

toString in class Object

Returns:

String representation of this object.