Method Detail

• getFormattedMessage

  String getFormattedMessage()

  Gets the Message formatted as a String. Each Message implementation determines the appropriate way to format the data encapsulated in the Message. Messages that provide more than one way of formatting the Message will implement MultiformatMessage.

  This method will not be called for Messages that implement the StringBuilderFormattable interface: instead, the formatTo(StringBuilder) method will be called so the Message can format its contents without creating intermediate String objects.

  Returns:

  The message String.

• getFormat

  String getFormat()

  Gets the format portion of the Message.

  Returns:

  The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.

• getParameters

  Object[] getParameters()

  Gets parameter values, if any.

  Returns:

  An array of parameter values or null.

• getThrowable

  Throwable getThrowable()

  Gets the throwable, if any.

  Returns:

  the throwable or null.