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.
-
-
Constructor Summary
Constructors Constructor Description FormattingInfo(boolean leftAlign, int minLength, int maxLength, boolean leftTruncate)
Creates new instance.FormattingInfo(boolean leftAlign, int minLength, int maxLength, boolean leftTruncate, boolean zeroPad)
Creates new instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(int fieldStart, StringBuilder buffer)
Adjust the content of the buffer based on the specified lengths and alignment.static FormattingInfo
getDefault()
Gets default instance.int
getMaxLength()
Get maximum length.int
getMinLength()
Get minimum length.boolean
isLeftAligned()
Determine if left aligned.boolean
isLeftTruncate()
Determine if left truncated.boolean
isZeroPad()
Determine if zero-padded.String
toString()
Returns a String suitable for debugging.
-
-
-
Constructor Detail
-
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 truezeroPad
- use zero-padding instead of whitespace-padding
-
-
Method Detail
-
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.
-
-