org.boon.messages

Class MessageSpecification

java.lang.Object

org.boon.messages.MessageSpecification

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseValidator

public class MessageSpecification
extends Object
implements Serializable

Contains information about how to generate a message. This class knows how to create a message. It will look up the message in the resource bundle if it starts with a "{".

Future: It will look up the message in the EL context if it starts with a "#{"

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageSpecification()

Method Summary

Methods

Modifier and Type	Method and Description
String	createDetailMessage(Object... args) Create the detailMessage message.
String	createMessage(String key, List<String> argKeys, Object... args) Creates a message.
String	createSummaryMessage(Object... args) Create the summaryMessage message.
protected List<String>	getDetailArgs()
protected String	getDetailMessage()
String	getName()
String	getSubject() Gets the current subject or the configured subject if the current subject is not found.
protected List<String>	getSummaryArgs()
protected String	getSummaryMessage()
void	init() The init method tries to generate the message keys.
boolean	isNoSummary()
void	setCurrentSubject(String subject) Allows client objects to set the subject for the current thread per instance of the MessageSpecification.
void	setDetailArgs(List<String> argKeys)
void	setDetailMessage(String detailKey)
void	setName(String aName)
void	setNoSummary(boolean noSummary)
void	setParent(String parent)
void	setSubject(String subject)
void	setSummaryArgs(List<String> summaryArgKeys)
void	setSummaryMessage(String summaryKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSpecification

public MessageSpecification()

Method Detail

init

public void init()

The init method tries to generate the message keys. You should only call the init method if you don't inject values into the detailMessage and summaryMessage.

isNoSummary

public boolean isNoSummary()

setNoSummary

public void setNoSummary(boolean noSummary)

createSummaryMessage

public String createSummaryMessage(Object... args)

Create the summaryMessage message.

createDetailMessage

public String createDetailMessage(Object... args)

Create the detailMessage message.

createMessage

public String createMessage(String key,
                   List<String> argKeys,
                   Object... args)

Creates a message.

Parameters:

argKeys - arguments to lookup that were configured.

args - Arguments that were passed via the object that wants to generate the message

setCurrentSubject

public void setCurrentSubject(String subject)

Allows client objects to set the subject for the current thread per instance of the MessageSpecification.

getSubject

public String getSubject()

Gets the current subject or the configured subject if the current subject is not found.

getDetailMessage

protected String getDetailMessage()

setDetailMessage

public void setDetailMessage(String detailKey)

getSummaryMessage

protected String getSummaryMessage()

setSummaryMessage

public void setSummaryMessage(String summaryKey)

getDetailArgs

protected List<String> getDetailArgs()

setDetailArgs

public void setDetailArgs(List<String> argKeys)

getSummaryArgs

protected List<String> getSummaryArgs()

setSummaryArgs

public void setSummaryArgs(List<String> summaryArgKeys)

setName

public void setName(String aName)

getName

public String getName()

setParent

public void setParent(String parent)

setSubject

public void setSubject(String subject)