Class FormattingInfo

java.lang.Object
org.apache.logging.log4j.core.pattern.FormattingInfo

public final class FormattingInfo extends Object
Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.
  • Field Details

    • SPACES

      private static final char[] SPACES
      Array of spaces.
    • ZEROS

      private static final char[] ZEROS
      Array of zeros.
    • DEFAULT

      private static final FormattingInfo DEFAULT
      Default instance.
    • minLength

      private final int minLength
      Minimum length.
    • maxLength

      private final int maxLength
      Maximum length.
    • leftAlign

      private final boolean leftAlign
      Alignment.
    • leftTruncate

      private final boolean leftTruncate
      Left vs. right-hand side truncation.
    • zeroPad

      private final boolean zeroPad
      Use zero-padding instead whitespace padding
    • EMPTY_ARRAY

      public static final FormattingInfo[] EMPTY_ARRAY
      Empty array.
  • Constructor Details

    • FormattingInfo

      public FormattingInfo(boolean leftAlign, int minLength, int maxLength, boolean leftTruncate)
      Creates new instance.
      Parameters:
      leftAlign - left align if true.
      minLength - minimum length.
      maxLength - maximum length.
      leftTruncate - truncates to the left if true
    • FormattingInfo

      public FormattingInfo(boolean leftAlign, int minLength, int maxLength, boolean leftTruncate, boolean zeroPad)
      Creates new instance.
      Parameters:
      leftAlign - left align if true.
      minLength - minimum length.
      maxLength - maximum length.
      leftTruncate - truncates to the left if true
      zeroPad - use zero-padding instead of whitespace-padding
  • Method Details

    • getDefault

      public static FormattingInfo getDefault()
      Gets default instance.
      Returns:
      default instance.
    • isLeftAligned

      public boolean isLeftAligned()
      Determine if left aligned.
      Returns:
      true if left aligned.
    • isLeftTruncate

      public boolean isLeftTruncate()
      Determine if left truncated.
      Returns:
      true if left truncated.
    • isZeroPad

      public boolean isZeroPad()
      Determine if zero-padded.
      Returns:
      true if zero-padded.
    • getMinLength

      public int getMinLength()
      Get minimum length.
      Returns:
      minimum length.
    • getMaxLength

      public int getMaxLength()
      Get maximum length.
      Returns:
      maximum length.
    • format

      public void format(int fieldStart, StringBuilder buffer)
      Adjust the content of the buffer based on the specified lengths and alignment.
      Parameters:
      fieldStart - start of field in buffer.
      buffer - buffer to be modified.
    • toString

      public String toString()
      Returns a String suitable for debugging.
      Overrides:
      toString in class Object
      Returns:
      a String suitable for debugging.