Package org.apache.commons.cli.help
Class TextStyle
java.lang.Object
org.apache.commons.cli.help.TextStyle
The definition for styling recommendations blocks of text. Most common usage is to style columns in a table, but may also be used to specify default styling
for a
HelpAppendable
. HelpWriters are free to ignore the TextStyle recommendations particularly where they are not supported or contradict common
usage.- Since:
- 1.10.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The alignment possibilities.static final class
The builder for the TextStyle. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final TextStyle
The default style as generated by the default Builder.static final int
The unset value for maxWidth: 2147483647. -
Method Summary
Modifier and TypeMethodDescriptionstatic TextStyle.Builder
builder()
Creates a new builder.Gets the alignment.int
Gets the indent value.int
Gets the left padding.int
gets the maximum width.int
gets the minimum width.boolean
Specifies if the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.pad
(boolean addIndent, CharSequence text) Pads a string to the maximum width or optionally to the maximum width - indent.toString()
-
Field Details
-
UNSET_MAX_WIDTH
The unset value for maxWidth: 2147483647.- See Also:
-
DEFAULT
The default style as generated by the default Builder.
-
-
Method Details
-
builder
Creates a new builder.- Returns:
- a new builder.
-
getAlignment
Gets the alignment.- Returns:
- the alignment.
-
getIndent
Gets the indent value.- Returns:
- the indent value.
-
getLeftPad
Gets the left padding.- Returns:
- the left padding.
-
getMaxWidth
gets the maximum width.- Returns:
- The maximum width.
-
getMinWidth
gets the minimum width.- Returns:
- The minimum width.
-
isScalable
Specifies if the column can be made wider or to narrower width to fit constraints of the HelpAppendable and formatting.- Returns:
- the scaling value.
-
pad
Pads a string to the maximum width or optionally to the maximum width - indent.- Returns the string unchanged if it is longer than the specified length.
- Will add the padding based on the alignment.
- Parameters:
addIndent
- iftrue
account for the indent when padding the string.text
- the text to pad.- Returns:
- the padded string.
-
toString
-