Class TextStyle

java.lang.Object
org.apache.commons.cli.help.TextStyle

public final class TextStyle extends Object
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
  • Field Details

  • Method Details

    • builder

      public static TextStyle.Builder builder()
      Creates a new builder.
      Returns:
      a new builder.
    • getAlignment

      Gets the alignment.
      Returns:
      the alignment.
    • getIndent

      public int getIndent()
      Gets the indent value.
      Returns:
      the indent value.
    • getLeftPad

      public int getLeftPad()
      Gets the left padding.
      Returns:
      the left padding.
    • getMaxWidth

      public int getMaxWidth()
      gets the maximum width.
      Returns:
      The maximum width.
    • getMinWidth

      public int getMinWidth()
      gets the minimum width.
      Returns:
      The minimum width.
    • isScalable

      public boolean 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

      public CharSequence pad(boolean addIndent, CharSequence text)
      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 - if true account for the indent when padding the string.
      text - the text to pad.
      Returns:
      the padded string.
    • toString

      public String toString()
      Overrides:
      toString in class Object