Package org.jboss.logmanager.formatters

Class StructuredFormatter

    • Constructor Detail

      • StructuredFormatter

        protected StructuredFormatter()

      • StructuredFormatter

        protected StructuredFormatter​(String keyOverrides)

    • Method Detail

      • createGenerator

        protected abstract StructuredFormatter.Generator createGenerator​(Writer writer)
                                                          throws Exception
        Creates the generator used to create the structured data.
        Returns:
        the generator to use
        Throws:
        Exception - if an error occurs creating the generator

      • getKey

        protected final String getKey​(StructuredFormatter.Key defaultKey)
        Checks to see if the key should be overridden.
        Parameters:
        defaultKey - the default key
        Returns:
        the overridden key or the default key if no override exists

      • format

        public final String format​(ExtLogRecord record)
        Description copied from class: ExtFormatter
        Format a message using an extended log record.
        Specified by:
        format in class ExtFormatter
        Parameters:
        record - the log record
        Returns:
        the formatted message

      • getKeyOverrides

        public String getKeyOverrides()
        A string representation of the key overrides. The default is null.
        Returns:
        a string representation of the key overrides or null if no overrides were configured

      • getRecordDelimiter

        public String getRecordDelimiter()
        Returns the character used to indicate the record has is complete. This defaults to \n and may be null if no end of record character is desired.
        Returns:
        the end of record delimiter or null if no delimiter is desired

      • setRecordDelimiter

        public void setRecordDelimiter​(String eorDelimiter)
        Sets the value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record.
        Parameters:
        eorDelimiter - the delimiter to be used or null to not use a delimiter

      • getMetaData

        public String getMetaData()
        Returns the value set for meta data.

        The value is a string where key/value pairs are separated by commas. The key and value are separated by an equal sign.

        Returns:
        the meta data string or null if one was not set
        See Also:
        PropertyValues.stringToMap(String)

      • setMetaData

        public void setMetaData​(String metaData)
        Sets the meta data to use in the structured format.

        The value is a string where key/value pairs are separated by commas. The key and value are separated by an equal sign.

        Parameters:
        metaData - the meta data to set or null to not format any meta data
        See Also:
        PropertyValues.stringToMap(String)

      • getDateTimeFormatter

        public DateTimeFormatter getDateTimeFormatter()
        Returns the current formatter used to format a records date and time.
        Returns:
        the current formatter

      • setDateFormat

        public void setDateFormat​(String pattern)
        Sets the pattern to use when formatting the date. The pattern must be a valid DateTimeFormatter.ofPattern(String) pattern.

        If the pattern is null a default formatter will be used. The zone id will always be appended to the formatter. By default the zone id will default to the systems zone id.

        Parameters:
        pattern - the pattern to use or null to use a default pattern

      • isPrintDetails

        public boolean isPrintDetails()
        Indicates whether or not details should be printed.
        Returns:
        true if details should be printed, otherwise false

      • setPrintDetails

        public void setPrintDetails​(boolean printDetails)
        Sets whether or not details should be printed.

        Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number.

        Parameters:
        printDetails - true if details should be printed

      • isDetailedExceptionOutputType

        protected boolean isDetailedExceptionOutputType()
        Checks the exception output type and determines if detailed output should be written.
        Returns:
        true if detailed output should be written, otherwise false

      • isFormattedExceptionOutputType

        protected boolean isFormattedExceptionOutputType()
        Checks the exception output type and determines if formatted output should be written. The formatted output is equivalent to Throwable.printStackTrace().
        Returns:
        true if formatted exception output should be written, otherwise false