org.rvpf.base.logger

Class Message

Object

AbstractMessage

Message

All Implemented Interfaces:

Serializable, Message

@ThreadSafe
public final class Message
extends AbstractMessage

Provides message formatting and supports messages resources provided by the Messages class.

Note: the formatting is done only when at least one parameter is supplied; otherwise, the string is returned unmodified (single quotes do not have to be doubled and curly braces are ordinary characters).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message(Messages.Entry entry, Object... params) Constructs an instance.
Message(String format, Object... params) Constructs an instance.
Message(Throwable cause, Messages.Entry entry, Object... params) Constructs an instance.
Message(Throwable cause, String format, Object... params) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
static String	format(Messages.Entry entry, Object... params) Formats a message.
String	format(Object... params) Formats this.
static String	format(String format, Object... params) Formats a message.
Optional<Throwable>	getCause() Gets the cause of this message.
Optional<Messages.Entry>	getEntry() Gets the entry.
Object[]	getParams() Gets the params.
static String	mark(String format, Object... params) Marks a message format for conversion to resource.
String	toString()

Methods inherited from class AbstractMessage

getFormat, getFormattedMessage, getParameters, getThrowable, saveFormatted

Methods inherited from class Object

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

Constructor Detail

Message

public Message(@Nonnull
               Messages.Entry entry,
               @Nonnull
               Object... params)

Constructs an instance.

Parameters:

entry - The messages entry.

params - The message parameters.

Message

public Message(@Nonnull
               String format,
               @Nonnull
               Object... params)

Constructs an instance.

Parameters:

format - The message format.

params - The message parameters.

Message

public Message(@Nonnull
               Throwable cause,
               @Nonnull
               Messages.Entry entry,
               @Nonnull
               Object... params)

Constructs an instance.

Parameters:

cause - The message cause.

entry - The messages entry.

params - The message parameters.

Message

public Message(@Nonnull
               Throwable cause,
               @Nonnull
               String format,
               @Nonnull
               Object... params)

Constructs an instance.

Parameters:

cause - The message cause.

format - The message format.

params - The message parameters.

Method Detail

format

@Nonnull
 @CheckReturnValue
public static String format(@Nonnull
                                                          Messages.Entry entry,
                                                          @Nonnull
                                                          Object... params)

Formats a message.

Parameters:

entry - The messages entry.

params - The message parameters.

Returns:

The formatted message.

format

@Nonnull
 @CheckReturnValue
public static String format(@Nonnull
                                                          String format,
                                                          @Nonnull
                                                          Object... params)

Formats a message.

Parameters:

format - The message format.

params - The message parameters.

Returns:

The formatted message.

mark

@Nonnull
 @CheckReturnValue
public static String mark(@Nonnull
                                                        String format,
                                                        @Nonnull
                                                        Object... params)

Marks a message format for conversion to resource.

The message formats needing conversion can be found by performing a search for all calls to this method.

Parameters:

format - The message format.

params - The message parameters.

Returns:

The message format.

format

@Nonnull
 @CheckReturnValue
public String format(@Nonnull
                                                   Object... params)

Formats this.

Parameters:

params - The message parameters.

Returns:

The formatted text.

getCause

@Nonnull
 @CheckReturnValue
public Optional<Throwable> getCause()

Gets the cause of this message.

Returns:

The optional cause.

getEntry

@Nonnull
 @CheckReturnValue
public Optional<Messages.Entry> getEntry()

Gets the entry.

Returns:

The optional entry.

getParams

@Nonnull
 @CheckReturnValue
public Object[] getParams()

Gets the params.

Returns:

The params.

toString

public String toString()

Overrides:

toString in class Object