eu.bandm.tools.muli

Class MuLiMessageReceiver<D>

java.lang.Object

eu.bandm.tools.message.SingleSender<SimpleMessage<D>>

eu.bandm.tools.muli.MuLiMessageReceiver<D>

All Implemented Interfaces:

MessageReceiver<SimpleMessage<D>>

Direct Known Subclasses:

MuLiMessageStore

public class MuLiMessageReceiver<D>
extends SingleSender<SimpleMessage<D>>
implements MessageReceiver<SimpleMessage<D>>

A subclass of MessageReceiver, providing convenience methods for generating and translating SimpleMessages.

The translation process is defined by an non-null instance of CatalogByString and a (normally non-empty) list of language preferences, as needed by MuLi.

A MuLiMessageReceiver is mostly used as a generator for messages: By calling the different generating methods error(...), log(...), warning(...), etc., a SimpleMessage is constructed (similar to the construction API in SimpleMessage.Generator) and sent to the one currently connected receiver, as defined by SingleSender. For this constructing, the message text itself and all embedded components will (1) be translated separately and then (2) combined by String formatting as described with Catalog#translateAllAndFormatRobust(String,List,Object...).
For convenience, since in nearly every application context errors and warnings have to be detected by counting, a MessageCounter is fed in parallel with the connected receiver. This can be retrieved by getCounter(), and further inquired or reset, etc.

For compatibility, instances of this class may also be used as message receivers as defined by MessageReceiver. Then they propagate all received messages after translating the text component as a whole. This is only sensible in the (rare) cases when the message texts are constants as a whole, i.e. do not contain variable sub-texts.

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogByString	catalog
protected MessageCounter	counter
protected List<String>	prefs
static String	terminationText

Fields inherited from class eu.bandm.tools.message.SingleSender

receiver

Constructor Summary

Constructors

Constructor and Description
MuLiMessageReceiver(MessageReceiver<SimpleMessage<D>> receiver, CatalogByString cat, List<String> prefs)
MuLiMessageReceiver(MessageReceiver<SimpleMessage<D>> receiver, CatalogByString cat, String... prefs)

Method Summary

Modifier and Type	Method and Description
void	error(Exception cause, Location<D> loc, String txt, Object... args) (1) Translate the text and all args, then (2) construct a SimpleMessage and (3) send it to the current SingleSender.receiver.
void	error(Location<D> loc, String txt, Object... args)
void	error(String txt, Object... args)
void	failure(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.failure.
void	failure(Location<D> loc, String txt, Object... args)
void	failure(String txt, Object... args)
CatalogByString	getCatalog()
MessageCounter	getCounter()
int	getMarkedErros() Returns the number of new critical errors occured after the last call to markCriticalErrors()
List<String>	getPrefs()
void	hint(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.hint.
void	hint(Location<D> loc, String txt, Object... args)
void	hint(String txt, Object... args)
void	log(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.log.
void	log(Location<D> loc, String txt, Object... args)
void	log(String txt, Object... args)
void	logEnd(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.logEnd.
void	logEnd(Location<D> loc, String txt, Object... args)
void	logEnd(String txt, Object... args)
void	logStart(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.logStart.
void	logStart(Location<D> loc, String txt, Object... args)
void	logStart(String txt, Object... args)
int	markCriticalErrors() Stores the number of critical errors for later retrieval by getMarkedErros().
static <X> MuLiMessageReceiver<X>	noTranslate(MessageReceiver<SimpleMessage<X>> rec) Wrap a MessageReceiver into a MuLiMessageReceiver with NOT TRANSLATION at all.
void	receive(SimpleMessage<D> msg)
protected void	send(Message.Kind kind, Exception cause, Location<D> loc, String txt, List<Object> args)
protected void	send(Message.Kind kind, Exception cause, Location<D> loc, String txt, Object... args)
void	send(MuLiException exc)
void	setCatalog(CatalogByString catalog)
void	setPreferences(List<String> prefs)
void	setPreferences(String... prefs)
void	terminateApplicationOnErrors()
void	terminateApplicationOnErrors(int returnCode)
void	warning(Exception cause, Location<D> loc, String txt, Object... args) Same as error(...), only the kind of the constructed method differs, it is Message.Kind.warning.
void	warning(Location<D> loc, String txt, Object... args)
void	warning(String txt, Object... args)

Methods inherited from class eu.bandm.tools.message.SingleSender

getReceiver, send, setReceiver

Methods inherited from class java.lang.Object

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

Field Detail

catalog

protected CatalogByString catalog

prefs

protected List<String> prefs

counter

protected MessageCounter counter

terminationText

public static final String terminationText

See Also:

Constant Field Values

Constructor Detail

MuLiMessageReceiver

public MuLiMessageReceiver(MessageReceiver<SimpleMessage<D>> receiver,
                           CatalogByString cat,
                           String... prefs)

Parameters:

cat - defines the translation process. must be !=null.

receiver - where to send the constructed (or propagated) messages.

MuLiMessageReceiver

public MuLiMessageReceiver(MessageReceiver<SimpleMessage<D>> receiver,
                           CatalogByString cat,
                           List<String> prefs)

Method Detail

noTranslate

public static <X> MuLiMessageReceiver<X> noTranslate(MessageReceiver<SimpleMessage<X>> rec)

Wrap a MessageReceiver into a MuLiMessageReceiver with NOT TRANSLATION at all.

setCatalog

public void setCatalog(CatalogByString catalog)

getCatalog

public CatalogByString getCatalog()

setPreferences

public void setPreferences(String... prefs)

setPreferences

public void setPreferences(List<String> prefs)

getPrefs

public List<String> getPrefs()

receive

public void receive(SimpleMessage<D> msg)

Specified by:

receive in interface MessageReceiver<SimpleMessage<D>>

getCounter

public MessageCounter getCounter()

markCriticalErrors

public int markCriticalErrors()

Stores the number of critical errors for later retrieval by getMarkedErros().

getMarkedErros

public int getMarkedErros()

Returns the number of new critical errors occured after the last call to markCriticalErrors()

terminateApplicationOnErrors

public void terminateApplicationOnErrors(int returnCode)

terminateApplicationOnErrors

public void terminateApplicationOnErrors()

send

public void send(MuLiException exc)

send

protected void send(Message.Kind kind,
                    Exception cause,
                    Location<D> loc,
                    String txt,
                    Object... args)

send

protected void send(Message.Kind kind,
                    Exception cause,
                    Location<D> loc,
                    String txt,
                    List<Object> args)

error

public void error(Exception cause,
                  Location<D> loc,
                  String txt,
                  Object... args)

(1) Translate the text and all args, then (2) construct a SimpleMessage and (3) send it to the current SingleSender.receiver.
The translation is ruled by the current value of prefs and the contents of catalog, which must be != null. The translation is done by delegation to Catalog.translateAllAndFormatRobust(String,String[],,Object...)
The type of the constructed method is Message.Kind.error.
The code crashes intentionally if no SingleSender.receiver is set, as described in the user documentation
All these convenience methods start with an Exception argument, followed by a Location. There is one additional variant which leaves out the initial Exception. As a consequence, the Location can be set to null NOT NEEDING casting, if an Exception is present.

warning

public void warning(Exception cause,
                    Location<D> loc,
                    String txt,
                    Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.warning.

See Also:

#error(Exception,Location,String,Object...).

failure

public void failure(Exception cause,
                    Location<D> loc,
                    String txt,
                    Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.failure.

See Also:

#error(Exception,Location,String,Object...).

hint

public void hint(Exception cause,
                 Location<D> loc,
                 String txt,
                 Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.hint.

See Also:

#error(Exception,Location,String,Object...).

log

public void log(Exception cause,
                Location<D> loc,
                String txt,
                Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.log.

See Also:

#error(Exception,Location,String,Object...).

logStart

public void logStart(Exception cause,
                     Location<D> loc,
                     String txt,
                     Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.logStart.

See Also:

#error(Exception,Location,String,Object...).

logEnd

public void logEnd(Exception cause,
                   Location<D> loc,
                   String txt,
                   Object... args)

Same as error(...), only the kind of the constructed method differs, it is Message.Kind.logEnd.

See Also:

#error(Exception,Location,String,Object...).

error

public void error(Location<D> loc,
                  String txt,
                  Object... args)

warning

public void warning(Location<D> loc,
                    String txt,
                    Object... args)

failure

public void failure(Location<D> loc,
                    String txt,
                    Object... args)

hint

public void hint(Location<D> loc,
                 String txt,
                 Object... args)

log

public void log(Location<D> loc,
                String txt,
                Object... args)

logStart

public void logStart(Location<D> loc,
                     String txt,
                     Object... args)

logEnd

public void logEnd(Location<D> loc,
                   String txt,
                   Object... args)

error

public void error(String txt,
                  Object... args)

warning

public void warning(String txt,
                    Object... args)

failure

public void failure(String txt,
                    Object... args)

hint

public void hint(String txt,
                 Object... args)

log

public void log(String txt,
                Object... args)

logStart

public void logStart(String txt,
                     Object... args)

logEnd

public void logEnd(String txt,
                   Object... args)