com.yahoo.bard.webservice

Interface MessageFormatter

All Known Implementing Classes:

ConfigMessageFormat, ErrorMessageFormat, SecurityErrorMessageFormat

public interface MessageFormatter

Message Formatter interface provides shared functionality to support classes which provide formatted logging and messaging.

Method Summary

Modifier and Type	Method and Description
default String	format(Object... values) Format a message for reporting to a user/client.
String	getLoggingFormat() The message format used for logging.
String	getMessageFormat() The message format used for publishing out of the system, typically in error messages.
default String	logFormat(Object... values) Format a message for writing to the log.

Method Detail

getMessageFormat

String getMessageFormat()

The message format used for publishing out of the system, typically in error messages.

Returns:

The format for messages

getLoggingFormat

String getLoggingFormat()

The message format used for logging.

Returns:

The format for log messages

format

default String format(Object... values)

Format a message for reporting to a user/client.

Parameters:

values - The values to populate the format string

Returns:

The user message

logFormat

default String logFormat(Object... values)

Format a message for writing to the log.

Parameters:

values - The values to populate the format string

Returns:

The logging message