cz.ues.platform.essentials.message

Class Message

java.lang.Object

cz.ues.platform.essentials.message.Message

public class Message
extends java.lang.Object

Class representing system message.

Since:

UES6-00

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Message.Code Default message code.

Field Summary

Fields

Modifier and Type	Field and Description
private MessageCode	code Code of message.
private java.lang.String	message Message text.
private java.lang.Object[]	parameters Parameters of message.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Message() Creates new instance of message.
protected	Message(MessageCode aCode, java.lang.String aMessage, java.lang.Object... aParameters) Creates new instance of message.

Method Summary

Methods

Modifier and Type	Method and Description
MessageCode	getCode() Return code of message.
static Message	getInstance(MessageCode aCode, java.lang.String aMessage, java.lang.Object... aParameters) Returns new instance of message.
java.lang.String	getMessage() Returns message text.
java.lang.Object[]	getParameters() Returns parameters of message.
void	setCode(MessageCode aCode) Sets code of message.
void	setMessage(java.lang.String aMessage) Sets message text.
void	setParameters(java.lang.Object... aParameters) Sets parameters of message.
java.lang.String	toString() Returns localized and formatted message.

Methods inherited from class java.lang.Object

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

Field Detail

code

private code

Code of message.

message

private message

Message text.

parameters

private parameters

Parameters of message.

Constructor Detail

Message

protected Message()

Creates new instance of message.

Since:

UES6-00

Message

protected Message(MessageCode aCode,
java.lang.String aMessage,
java.lang.Object... aParameters)

Creates new instance of message.

Parameters:

aCode - Code of message

aMessage - Message text

aParameters - Parameters of message

Since:

UES6-00

Method Detail

getInstance

public static Message getInstance(MessageCode aCode,
java.lang.String aMessage,
java.lang.Object... aParameters)

Returns new instance of message.

Parameters:

aCode - Code of message

aMessage - Message text

aParameters - Parameters of message

Returns:

New instance of message

Since:

UES6-00

setCode

public void setCode(MessageCode aCode)

Sets code of message.

Parameters:

aCode - Code of message

Since:

UES6-00

getCode

public MessageCode getCode()

Return code of message.

Returns:

Code of message

Since:

UES6-00

setMessage

public void setMessage(java.lang.String aMessage)

Sets message text.

Parameters:

aMessage - Message text

Since:

UES6-00

getMessage

public java.lang.String getMessage()

Returns message text.

Returns:

Message text

Since:

UES6-00

setParameters

public void setParameters(java.lang.Object... aParameters)

Sets parameters of message.

Parameters:

aParameters - Parameters of message

Since:

UES6-00

getParameters

public java.lang.Object[] getParameters()

Returns parameters of message.

Returns:

Parameters of message

Since:

UES6-00

toString

public java.lang.String toString()

Returns localized and formatted message.

Overrides:

toString in class java.lang.Object

Returns:

Localized and formatted message.

Since:

UES6-00