Package eu.bandm.tools.message

Class MessageFormatter<D>

java.lang.Object

eu.bandm.tools.message.SingleSender<M>

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

eu.bandm.tools.message.MessageFormatter<D>

All Implemented Interfaces:

MessageReceiver<SimpleMessage<D>>

public class MessageFormatter<D>
extends MessagePasser<SimpleMessage<D>>

Interprets the SimpleMessage.args values as arguments to string formatting and calls String.format(String,Object...). Propagates to its drain a message with the new text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageFormatter.Formandum	Wraps any text as argument, which itself shall be translated and formatted.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	stripArgs	Whether the args are only entered to formatting, but not propagated.

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

receiver

Constructor Summary

Constructors

Constructor	Description
MessageFormatter()
MessageFormatter(MessageReceiver<? super SimpleMessage<D>> rec)

Method Summary

Modifier and Type	Method	Description
static MessageFormatter.Formandum	formandum(String s, Object... args)	Convenience method to wrap an argument string and mark it for translation and formatting.
static @Opt String	process(@Opt String text, Object[] args)	Applies the text as a format to the arguments.
static @Opt String	process(MessageFormatter.Formandum embed)	Applies the text as a format to the arguments.
void	receive(SimpleMessage<D> m)	Applies the message text as a format to the arguments and propagates the new message to the current drain.
static @Opt String	render(SimpleMessage<?> msg)	Applies the text as a format to the arguments.
void	setStripArgs(boolean b)	Evident

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 Details

stripArgs

protected boolean stripArgs

Whether the args are only entered to formatting, but not propagated. Initially true.

Constructor Details

MessageFormatter

public MessageFormatter()

MessageFormatter

public MessageFormatter(MessageReceiver<? super SimpleMessage<D>> rec)

Method Details

setStripArgs

public void setStripArgs(boolean b)

Evident

receive

public void receive(SimpleMessage<D> m)

Applies the message text as a format to the arguments and propagates the new message to the current drain.

Specified by:

receive in interface MessageReceiver<D>

Overrides:

receive in class MessagePasser<SimpleMessage<D>>

See Also:

• (SimpleMessage)

render

@Opt
public static @Opt String render(SimpleMessage<?> msg)

Applies the text as a format to the arguments. String.format(String,Object...) is called in any case, also with empty arg list, for format codes like "%n". Any MessageFormatter.Formandum is treated recursively. Any formatting which fails returns the concatenation of the text, an error text and the Object.toString() results of the arguments.

process

@Opt
public static @Opt String process(MessageFormatter.Formandum embed)

Applies the text as a format to the arguments.

See Also:

• process(@eu.bandm.tools.annotations.Opt java.lang.String,java.lang.Object[])

process

@Opt
public static @Opt String process(@Opt
 @Opt String text,
 Object[] args)

Applies the text as a format to the arguments. String.format(String,Object...) is called in any case, also with empty args list, to format codes like "%n" and "%%". Any MessageFormatter.Formandum is treated recursively. Any formatting which fails returns the concatenation of the text, an error text and the Object.toString() results of the arguments.

formandum

public static MessageFormatter.Formandum formandum(String s,
 Object... args)

Convenience method to wrap an argument string and mark it for translation and formatting.