org.jbind.message
Class AbstractMessage

java.lang.Object
  org.jbind.message.AbstractMessage

All Implemented Interfaces:

IMessage

Direct Known Subclasses:

CompositeMessage, DecoratedMessage, SimpleMessage

public abstract class AbstractMessage

extends java.lang.Object

implements IMessage

Constructor Summary

AbstractMessage(IMessageFormats aMessageFormats, java.lang.String aKey)

Method Summary

java.lang.String	getOrigin()
protected abstract java.lang.Object	getParameters(java.util.Locale aLocale)
java.lang.String	output(java.util.Locale aLocale) Outputs this message and all of its sub-messages.
java.lang.String	output(java.util.Locale aLocale, boolean anIndent, boolean anOutputContainerLines) Outputs this message and all of its sub-messages.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jbind.message.IMessage

addTo, isComposite, isEmpty, iterSimpleMessages, iterSubMessages

Constructor Detail

AbstractMessage

public AbstractMessage(IMessageFormats aMessageFormats,
                       java.lang.String aKey)

Method Detail

output

public final java.lang.String output(java.util.Locale aLocale)

Description copied from interface: IMessage

Outputs this message and all of its sub-messages.

If this message is a composite message then first a line is output for the composite and then each sub-message is output on a line of its own that is indented one tab relative to the line of the composite. This method corresponds to calling output(aLocale, true, true).

Specified by:

output in interface IMessage

Parameters:

aLocale - (optional).

Returns:

(required).

output

public java.lang.String output(java.util.Locale aLocale,
                               boolean anIndent,
                               boolean anOutputContainerLines)

Description copied from interface: IMessage

Outputs this message and all of its sub-messages.

Best efforts are undertaken that the message is output using the specified locale. However, if the message can not be output using the specified locale then another locale is used.

Specified by:

output in interface IMessage

Parameters:

aLocale - (optional).

anIndent - Determines if sub messages are indented or not.

anOutputContainerLines - Determines if a composite message outputs a line for itself or if it outputs its sub messages only.

Returns:

(required).

getParameters

protected abstract java.lang.Object getParameters(java.util.Locale aLocale)

getOrigin

public java.lang.String getOrigin()

Specified by:

getOrigin in interface IMessage

toString

public java.lang.String toString()