Class DefaultLogBuilder

  • All Implemented Interfaces:
    BridgeAware, LogBuilder

    public class DefaultLogBuilder
    extends java.lang.Object
    implements BridgeAware, LogBuilder
    Collects data for a log event and then logs it. This class should be considered private.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean isEnabled​(java.lang.CharSequence message)  
      protected boolean isEnabled​(java.lang.Object message)  
      protected boolean isEnabled​(java.lang.String message)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object... params)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8)  
      protected boolean isEnabled​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8, java.lang.Object p9)  
      protected boolean isEnabled​(Message message)  
      boolean isInUse()  
      private boolean isValid()  
      void log()
      Causes all the data collected to be logged.
      void log​(java.lang.CharSequence message)
      Causes all the data collected to be logged along with the message.
      void log​(java.lang.Object message)
      Causes all the data collected to be logged along with the message.
      void log​(java.lang.String message)
      Causes all the data collected to be logged along with the message.
      void log​(java.lang.String message, java.lang.Object p0)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object... params)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8)
      Logs a message with parameters.
      void log​(java.lang.String message, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8, java.lang.Object p9)
      Logs a message with parameters.
      void log​(java.lang.String message, Supplier<?>... params)
      Causes all the data collected to be logged along with the message and parameters.
      void log​(Message message)
      Causes all the data collected to be logged along with the message.
      void log​(Supplier<Message> messageSupplier)
      Causes all the data collected to be logged along with the message.
      Message logAndGet​(Supplier<Message> messageSupplier)
      Causes all the data collected to be logged along with the message.
      private void logMessage​(Message message)  
      LogBuilder reset​(ExtendedLogger logger, Level level)
      This method should be considered internal.
      void setEntryPoint​(java.lang.String fqcn)
      Fully qualified class name of the entry point to the logging system.
      LogBuilder withLocation()
      An implementation will calculate the caller's stack frame and include it in the log event.
      LogBuilder withLocation​(java.lang.StackTraceElement location)
      Adds the specified stack trace element to the log event.
      LogBuilder withMarker​(Marker marker)
      Includes a Marker in the log event.
      LogBuilder withThrowable​(java.lang.Throwable throwable)
      Includes a Throwable in the log event.
      • Methods inherited from class java.lang.Object

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

      • EMPTY_MESSAGE

        private static Message EMPTY_MESSAGE
      • FQCN

        private static final java.lang.String FQCN
      • LOGGER

        private static final Logger LOGGER
      • level

        private Level level
      • marker

        private Marker marker
      • throwable

        private java.lang.Throwable throwable
      • location

        private java.lang.StackTraceElement location
      • inUse

        private volatile boolean inUse
      • threadId

        private long threadId
      • fqcn

        private java.lang.String fqcn
    • Constructor Detail

      • DefaultLogBuilder

        public DefaultLogBuilder()
    • Method Detail

      • setEntryPoint

        public void setEntryPoint​(java.lang.String fqcn)
        Description copied from interface: BridgeAware
        Fully qualified class name of the entry point to the logging system. This class will not appear in the location information.
        Specified by:
        setEntryPoint in interface BridgeAware
      • reset

        public LogBuilder reset​(ExtendedLogger logger,
                                Level level)
        This method should be considered internal. It is used to reset the LogBuilder for a new log message.
        Parameters:
        level - The logging level for this event.
        Returns:
        This LogBuilder instance.
      • withMarker

        public LogBuilder withMarker​(Marker marker)
        Description copied from interface: LogBuilder
        Includes a Marker in the log event. Interface default method does nothing.
        Specified by:
        withMarker in interface LogBuilder
        Parameters:
        marker - The Marker to log.
        Returns:
        The LogBuilder.
      • withThrowable

        public LogBuilder withThrowable​(java.lang.Throwable throwable)
        Description copied from interface: LogBuilder
        Includes a Throwable in the log event. Interface default method does nothing.
        Specified by:
        withThrowable in interface LogBuilder
        Parameters:
        throwable - The Throwable to log.
        Returns:
        the LogBuilder.
      • withLocation

        public LogBuilder withLocation()
        Description copied from interface: LogBuilder
        An implementation will calculate the caller's stack frame and include it in the log event. Interface default method does nothing.
        Specified by:
        withLocation in interface LogBuilder
        Returns:
        The LogBuilder.
      • withLocation

        public LogBuilder withLocation​(java.lang.StackTraceElement location)
        Description copied from interface: LogBuilder
        Adds the specified stack trace element to the log event. Interface default method does nothing.
        Specified by:
        withLocation in interface LogBuilder
        Parameters:
        location - The stack trace element to include in the log event.
        Returns:
        The LogBuilder.
      • isInUse

        public boolean isInUse()
      • log

        public void log​(Message message)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - The message to log.
      • logAndGet

        public Message logAndGet​(Supplier<Message> messageSupplier)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message.
        Specified by:
        logAndGet in interface LogBuilder
        Parameters:
        messageSupplier - The supplier of the message to log.
        Returns:
        the message logger or null if no logging occurred.
      • log

        public void log​(java.lang.CharSequence message)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - The message to log.
      • log

        public void log​(java.lang.String message)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - The message to log.
      • log

        public void log​(java.lang.String message,
                        java.lang.Object... params)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        params - parameters to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        Supplier<?>... params)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message and parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - The message.
        params - Parameters to the message.
      • log

        public void log​(Supplier<Message> messageSupplier)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        messageSupplier - The supplier of the message to log.
      • log

        public void log​(java.lang.Object message)
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged along with the message. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - The message to log.
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4,
                        java.lang.Object p5)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        p5 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4,
                        java.lang.Object p5,
                        java.lang.Object p6)
        Description copied from interface: LogBuilder
        Logs a message with parameters.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        p5 - parameter to the message.
        p6 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4,
                        java.lang.Object p5,
                        java.lang.Object p6,
                        java.lang.Object p7)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        p5 - parameter to the message.
        p6 - parameter to the message.
        p7 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4,
                        java.lang.Object p5,
                        java.lang.Object p6,
                        java.lang.Object p7,
                        java.lang.Object p8)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        p5 - parameter to the message.
        p6 - parameter to the message.
        p7 - parameter to the message.
        p8 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log​(java.lang.String message,
                        java.lang.Object p0,
                        java.lang.Object p1,
                        java.lang.Object p2,
                        java.lang.Object p3,
                        java.lang.Object p4,
                        java.lang.Object p5,
                        java.lang.Object p6,
                        java.lang.Object p7,
                        java.lang.Object p8,
                        java.lang.Object p9)
        Description copied from interface: LogBuilder
        Logs a message with parameters. Interface default method does nothing.
        Specified by:
        log in interface LogBuilder
        Parameters:
        message - the message to log; the format depends on the message factory.
        p0 - parameter to the message.
        p1 - parameter to the message.
        p2 - parameter to the message.
        p3 - parameter to the message.
        p4 - parameter to the message.
        p5 - parameter to the message.
        p6 - parameter to the message.
        p7 - parameter to the message.
        p8 - parameter to the message.
        p9 - parameter to the message.
        See Also:
        Unbox
      • log

        public void log()
        Description copied from interface: LogBuilder
        Causes all the data collected to be logged. Default implementatoin does nothing.
        Specified by:
        log in interface LogBuilder
      • logMessage

        private void logMessage​(Message message)
      • isValid

        private boolean isValid()
      • isEnabled

        protected boolean isEnabled​(Message message)
      • isEnabled

        protected boolean isEnabled​(java.lang.CharSequence message)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object... params)
      • isEnabled

        protected boolean isEnabled​(java.lang.Object message)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4,
                                    java.lang.Object p5)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4,
                                    java.lang.Object p5,
                                    java.lang.Object p6)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4,
                                    java.lang.Object p5,
                                    java.lang.Object p6,
                                    java.lang.Object p7)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4,
                                    java.lang.Object p5,
                                    java.lang.Object p6,
                                    java.lang.Object p7,
                                    java.lang.Object p8)
      • isEnabled

        protected boolean isEnabled​(java.lang.String message,
                                    java.lang.Object p0,
                                    java.lang.Object p1,
                                    java.lang.Object p2,
                                    java.lang.Object p3,
                                    java.lang.Object p4,
                                    java.lang.Object p5,
                                    java.lang.Object p6,
                                    java.lang.Object p7,
                                    java.lang.Object p8,
                                    java.lang.Object p9)