Package org.apache.logging.log4j.message

Class DefaultFlowMessageFactory

  • All Implemented Interfaces:
    java.io.Serializable, FlowMessageFactory
    public class DefaultFlowMessageFactory
extends java.lang.Object
implements FlowMessageFactory, java.io.Serializable
    Default factory for flow messages.
    Since:
    2.6
    See Also:
    Serialized Form

    • Constructor Detail

      • DefaultFlowMessageFactory

        public DefaultFlowMessageFactory()
        Constructs a message factory with "Enter" and "Exit" as the default flow strings.

      • DefaultFlowMessageFactory

        public DefaultFlowMessageFactory​(java.lang.String entryText,
                                 java.lang.String exitText)
        Constructs a message factory with the given entry and exit strings.
        Parameters:
        entryText - the text to use for trace entry, like "Enter".
        exitText - the text to use for trace exit, like "Exit".

    • Method Detail

      • getEntryText

        public java.lang.String getEntryText()
        Gets the entry text.
        Returns:
        the entry text.

      • getExitText

        public java.lang.String getExitText()
        Gets the exit text.
        Returns:
        the exit text.

      • newEntryMessage

        public EntryMessage newEntryMessage​(java.lang.String format,
                                    java.lang.Object... params)
        Description copied from interface: FlowMessageFactory
        Creates a new entry message based on a format string with parameters.
        Specified by:
        newEntryMessage in interface FlowMessageFactory
        Parameters:
        format - format string
        params - parameters
        Returns:
        the new entry message

      • newExitMessage

        public ExitMessage newExitMessage​(java.lang.String format,
                                  java.lang.Object result)
        Description copied from interface: FlowMessageFactory
        Creates a new exit message based on a return value and a forma string.
        Specified by:
        newExitMessage in interface FlowMessageFactory
        Parameters:
        format - a format string
        result - the return value
        Returns:
        the new exit message

      • newExitMessage

        public ExitMessage newExitMessage​(Message message)
        Description copied from interface: FlowMessageFactory
        Creates a new exit message based on no return value and an existing message.
        Specified by:
        newExitMessage in interface FlowMessageFactory
        Parameters:
        message - the original entry message
        Returns:
        the new exit message

      • newExitMessage

        public ExitMessage newExitMessage​(java.lang.Object result,
                                  EntryMessage message)
        Description copied from interface: FlowMessageFactory
        Creates a new exit message based on a return value and an existing entry message.
        Specified by:
        newExitMessage in interface FlowMessageFactory
        Parameters:
        result - the return value.
        message - the original entry message
        Returns:
        the new exit message

      • newExitMessage

        public ExitMessage newExitMessage​(java.lang.Object result,
                                  Message message)
        Description copied from interface: FlowMessageFactory
        Creates a new exit message based on a return value and an existing message.
        Specified by:
        newExitMessage in interface FlowMessageFactory
        Parameters:
        result - the return value.
        message - the original message
        Returns:
        the new exit message