Class MessageFormatter

  • Direct Known Subclasses:
    AuditLog

    public class MessageFormatter
    extends java.lang.Object
    MessageFormatter is the superclass of audit log implementations. It provides the ability to format a message.
    • Constructor Summary

      Constructors 
      Constructor Description
      MessageFormatter()
      Default Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFormattedMessage​(MessageDefinition messageDefinition)
      Create a formatted message from a message definition instance.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MessageFormatter

        public MessageFormatter()
        Default Constructor
    • Method Detail

      • getFormattedMessage

        public java.lang.String getFormattedMessage​(MessageDefinition messageDefinition)
        Create a formatted message from a message definition instance. This instance contains the unique message identifier, the default message template and the parameters to insert into it. The Audit Log controls whether to use the default message template or substitute it for a version in a different language. The method is public to allow external components to format messages - for example, from exceptions.
        Parameters:
        messageDefinition - details about the message to format.
        Returns:
        formatted message