Package eu.bandm.tools.message

Class SimpleMessage.Sender<E>

java.lang.Object

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

eu.bandm.tools.message.SimpleMessage.Sender<E>

Type Parameters:

E - the type of the document identifier of the message locations

Enclosing class:

SimpleMessage<D>

public static class SimpleMessage.Sender<E>
extends SingleSender<SimpleMessage<E>>

A convenience class which allows to create and send a message with one single method invocation.

As with every SingleSender, the receiver must be set to a non-null value before the first message is received. Otherwise the code will crash intentionally.

Field Summary

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

drain

Constructor Summary

Constructors

Constructor	Description
Sender()	A constructor which requires subsequent setting of the receiver.
Sender(@Opt MessageReceiver<SimpleMessage<E>> msgr)	A constructor which sets the receiver of the messages.

Method Summary

Modifier and Type	Method	Description
void	error(Locatable<E> loc, String message, Object... args)	Send an error message with the given attributes, and set all others to default.
void	error(String message, Object... args)	Send an error message with the given attributes, and set all others to default.
void	error(Throwable ex, Locatable<E> loc, String message, Object... args)	Send an error message with the given attributes, and set all others to default.
void	error(Throwable ex, String message, Object... args)	Send an error message with the given attributes, and set all others to default.
void	failure(Locatable<E> loc, String message, Object... args)	Send a failure message with the given attributes, and set all others to default.
void	failure(String message, Object... args)	Send a failure message with the given attributes, and set all others to default.
void	failure(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a failure message with the given attributes, and set all others to default.
void	failure(Throwable ex, String message, Object... args)	Send a failure message with the given attributes, and set all others to default.
void	hint(Locatable<E> loc, String message, Object... args)	Send a hint message with the given attributes, and set all others to default.
void	hint(String message, Object... args)	Send a hint message with the given attributes, and set all others to default.
void	hint(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a hint message with the given attributes, and set all others to default.
void	hint(Throwable ex, String message, Object... args)	Send a hint message with the given attributes, and set all others to default.
void	log(Locatable<E> loc, String message, Object... args)	Send a log message with the given attributes, and set all others to default.
void	log(String message, Object... args)	Send a log message with the given attributes, and set all others to default.
void	log(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a log message with the given attributes, and set all others to default.
void	log(Throwable ex, String message, Object... args)	Send a log message with the given attributes, and set all others to default.
void	logEnd(Locatable<E> loc, String message, Object... args)	Send a log end message with the given attributes, and set all others to default.
void	logEnd(String message, Object... args)	Send a log end message with the given attributes, and set all others to default.
void	logEnd(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a log end message with the given attributes, and set all others to default.
void	logEnd(Throwable ex, String message, Object... args)	Send a log end message with the given attributes, and set all others to default.
void	logStart(Locatable<E> loc, String message, Object... args)	Send a log start message with the given attributes, and set all others to default.
void	logStart(String message, Object... args)	Send a log start message with the given attributes, and set all others to default.
void	logStart(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a log start message with the given attributes, and set all others to default.
void	logStart(Throwable ex, String message, Object... args)	Send a log start message with the given attributes, and set all others to default.
void	warning(Locatable<E> loc, String message, Object... args)	Send a warning message with the given attributes, and set all others to default.
void	warning(String message, Object... args)	Send a warning message with the given attributes, and set all others to default.
void	warning(Throwable ex, Locatable<E> loc, String message, Object... args)	Send a warning message with the given attributes, and set all others to default.
void	warning(Throwable ex, String message, Object... args)	Send a warning with the given attributes, and set all others to default.

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

getDrain, getReceiver, send, setDrain, setReceiver

Methods inherited from class java.lang.Object

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

Constructor Details

Sender

public Sender(@Opt
 @Opt MessageReceiver<SimpleMessage<E>> msgr)

A constructor which sets the receiver of the messages.

Parameters:

msgr - the receiver of the messages.

Sender

public Sender()

A constructor which requires subsequent setting of the receiver.

Method Details

log

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

Send a log message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

log

public void log(Locatable<E> loc,
 String message,
 Object... args)

Send a log message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

log

public void log(Throwable ex,
 String message,
 Object... args)

Send a log message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

log

public void log(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a log message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

logStart

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

Send a log start message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

logStart

public void logStart(Locatable<E> loc,
 String message,
 Object... args)

Send a log start message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

logStart

public void logStart(Throwable ex,
 String message,
 Object... args)

Send a log start message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

logStart

public void logStart(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a log start message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

logEnd

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

Send a log end message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

logEnd

public void logEnd(Locatable<E> loc,
 String message,
 Object... args)

Send a log end message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

logEnd

public void logEnd(Throwable ex,
 String message,
 Object... args)

Send a log end message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

logEnd

public void logEnd(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a log end message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

error

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

Send an error message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

error

public void error(Locatable<E> loc,
 String message,
 Object... args)

Send an error message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

error

public void error(Throwable ex,
 String message,
 Object... args)

Send an error message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

error

public void error(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send an error message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

warning

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

Send a warning message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

warning

public void warning(Locatable<E> loc,
 String message,
 Object... args)

Send a warning message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

warning

public void warning(Throwable ex,
 String message,
 Object... args)

Send a warning with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

warning

public void warning(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a warning message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

failure

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

Send a failure message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

failure

public void failure(Locatable<E> loc,
 String message,
 Object... args)

Send a failure message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

failure

public void failure(Throwable ex,
 String message,
 Object... args)

Send a failure message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

failure

public void failure(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a failure message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments

hint

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

Send a hint message with the given attributes, and set all others to default.

Parameters:

message - the message text

args - the message arguments

hint

public void hint(Locatable<E> loc,
 String message,
 Object... args)

Send a hint message with the given attributes, and set all others to default.

Parameters:

loc - the location of the message

message - the message text

args - the message arguments

hint

public void hint(Throwable ex,
 String message,
 Object... args)

Send a hint message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

message - the message text

args - the message arguments

hint

public void hint(Throwable ex,
 Locatable<E> loc,
 String message,
 Object... args)

Send a hint message with the given attributes, and set all others to default.

Parameters:

ex - the cause of the message

loc - the location of the message

message - the message text

args - the message arguments