Package org.apache.logging.log4j.core.impl

Class ThrowableFormatOptions

  • public final class ThrowableFormatOptions
extends java.lang.Object
    Contains options which control how a Throwable pattern is formatted.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CLASS_NAME  
      protected static ThrowableFormatOptions DEFAULT
      Default instance of ThrowableFormatOptions.
      private static int DEFAULT_LINES  
      static java.lang.String FILE_NAME  
      private static java.lang.String FULL
      Format the whole stack trace.
      private java.util.List<java.lang.String> ignorePackages
      The list of packages to filter.
      static java.lang.String LINE_NUMBER  
      private int lines
      The number of lines to write.
      static java.lang.String LOCALIZED_MESSAGE  
      static java.lang.String MESSAGE  
      static java.lang.String METHOD_NAME  
      private static java.lang.String NONE
      Do not format the exception.
      private java.lang.String separator
      The stack trace separator.
      private static java.lang.String SHORT
      Format only the first line of the throwable.
      private java.lang.String suffix  
      private TextRenderer textRenderer
      ANSI renderer

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ThrowableFormatOptions()
      Constructs the options for printing stack trace.
      protected ThrowableFormatOptions​(int lines, java.lang.String separator, java.util.List<java.lang.String> ignorePackages, TextRenderer textRenderer, java.lang.String suffix)
      Constructs the options for printing stack trace.
      protected ThrowableFormatOptions​(java.util.List<java.lang.String> packages)
      Constructs the options for printing stack trace.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean allLines()
      Determines if all lines should be printed.
      boolean anyLines()
      Determines if any lines should be printed.
      java.util.List<java.lang.String> getIgnorePackages()
      Returns the list of packages to ignore (filter out).
      int getLines()
      Returns the number of lines to write.
      java.lang.String getSeparator()
      Returns the stack trace separator.
      java.lang.String getSuffix()  
      TextRenderer getTextRenderer()
      Returns the message rendered.
      boolean hasPackages()
      Determines if there are any packages to filter.
      int minLines​(int maxLines)
      Returns the minimum between the lines and the max lines.
      static ThrowableFormatOptions newInstance​(java.lang.String[] options)
      Creates a new instance based on the array of options.
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • FULL

        private static final java.lang.String FULL
        Format the whole stack trace.
        See Also:
        Constant Field Values

      • NONE

        private static final java.lang.String NONE
        Do not format the exception.
        See Also:
        Constant Field Values

      • SHORT

        private static final java.lang.String SHORT
        Format only the first line of the throwable.
        See Also:
        Constant Field Values

      • textRenderer

        private final TextRenderer textRenderer
        ANSI renderer

      • lines

        private final int lines
        The number of lines to write.

      • separator

        private final java.lang.String separator
        The stack trace separator.

      • suffix

        private final java.lang.String suffix

      • ignorePackages

        private final java.util.List<java.lang.String> ignorePackages
        The list of packages to filter.

      • LOCALIZED_MESSAGE

        public static final java.lang.String LOCALIZED_MESSAGE
        See Also:
        Constant Field Values

    • Constructor Detail

      • ThrowableFormatOptions

        protected ThrowableFormatOptions​(int lines,
                                 java.lang.String separator,
                                 java.util.List<java.lang.String> ignorePackages,
                                 TextRenderer textRenderer,
                                 java.lang.String suffix)
        Constructs the options for printing stack trace.
        Parameters:
        lines - The number of lines.
        separator - The stack trace separator.
        ignorePackages - The packages to filter.
        textRenderer - The ANSI renderer
        suffix -

      • ThrowableFormatOptions

        protected ThrowableFormatOptions​(java.util.List<java.lang.String> packages)
        Constructs the options for printing stack trace.
        Parameters:
        packages - The packages to filter.

      • ThrowableFormatOptions

        protected ThrowableFormatOptions()
        Constructs the options for printing stack trace.

    • Method Detail

      • getLines

        public int getLines()
        Returns the number of lines to write.
        Returns:
        The number of lines to write.

      • getSeparator

        public java.lang.String getSeparator()
        Returns the stack trace separator.
        Returns:
        The stack trace separator.

      • getTextRenderer

        public TextRenderer getTextRenderer()
        Returns the message rendered.
        Returns:
        the message rendered.

      • getIgnorePackages

        public java.util.List<java.lang.String> getIgnorePackages()
        Returns the list of packages to ignore (filter out).
        Returns:
        The list of packages to ignore (filter out).

      • allLines

        public boolean allLines()
        Determines if all lines should be printed.
        Returns:
        true for all lines, false otherwise.

      • anyLines

        public boolean anyLines()
        Determines if any lines should be printed.
        Returns:
        true for any lines, false otherwise.

      • minLines

        public int minLines​(int maxLines)
        Returns the minimum between the lines and the max lines.
        Parameters:
        maxLines - The maximum number of lines.
        Returns:
        The number of lines to print.

      • hasPackages

        public boolean hasPackages()
        Determines if there are any packages to filter.
        Returns:
        true if there are packages, false otherwise.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • newInstance

        public static ThrowableFormatOptions newInstance​(java.lang.String[] options)
        Creates a new instance based on the array of options.
        Parameters:
        options - The array of options.
        Returns:
        A new initialized instance.

      • getSuffix

        public java.lang.String getSuffix()