Package org.wildfly.prospero.cli

Class CustomHelp

java.lang.Object
picocli.CommandLine.Help
org.wildfly.prospero.cli.CustomHelp
public class CustomHelp extends picocli.CommandLine.Help
Modified implementation of usage renderer. This mainly modifies the order of options in the usage message from the default behavior:
  • print option groups first,
  • sort by order argument.

    • Nested Class Summary

      Nested Classes
      Modifier and Type
      Class
      Description
      static class 
      CustomHelp.CustomHelpFactory
       

      Nested classes/interfaces inherited from class picocli.CommandLine.Help

      picocli.CommandLine.Help.Ansi, picocli.CommandLine.Help.ColorScheme, picocli.CommandLine.Help.Column, picocli.CommandLine.Help.IOptionRenderer, picocli.CommandLine.Help.IParameterRenderer, picocli.CommandLine.Help.IParamLabelRenderer, picocli.CommandLine.Help.Layout, picocli.CommandLine.Help.TextTable, picocli.CommandLine.Help.Visibility

    • Field Summary

      Fields inherited from class picocli.CommandLine.Help

      AT_FILE_POSITIONAL_PARAM, DEFAULT_COMMAND_NAME, DEFAULT_SEPARATOR, END_OF_OPTIONS_OPTION

    • Constructor Summary

      Constructors
      Constructor
      Description
      CustomHelp(picocli.CommandLine.Model.CommandSpec commandSpec, picocli.CommandLine.Help.ColorScheme colorScheme)
       

    • Method Summary

      Modifier and Type
      Method
      Description
      protected String
      makeSynopsisFromParts(int synopsisHeadingLength, picocli.CommandLine.Help.Ansi.Text optionText, picocli.CommandLine.Help.Ansi.Text groupsText, picocli.CommandLine.Help.Ansi.Text endOfOptionsText, picocli.CommandLine.Help.Ansi.Text positionalParamText, picocli.CommandLine.Help.Ansi.Text commandText)
      Override this to switch positions of groupsText and optionText.
      String
      synopsis(int synopsisHeadingLength)
      Override this to set custom options compatarator and clusterBooleanOptions parameter to false.

      Methods inherited from class picocli.CommandLine.Help

      abbreviatedSynopsis, addAllSubcommands, addSubcommand, aliases, allSubcommands, ansi, atFileParameterList, calcLongOptionColumnWidth, colorScheme, commandList, commandList, commandListHeading, commandNamesText, commandSpec, createDefaultLayout, createDefaultLayout, createDefaultOptionRenderer, createDefaultOptionSort, createDefaultParameterRenderer, createDefaultParamLabelRenderer, createDetailedSynopsisCommandText, createDetailedSynopsisEndOfOptionsText, createDetailedSynopsisGroupsText, createDetailedSynopsisOptionsText, createDetailedSynopsisOptionsText, createDetailedSynopsisPositionalsText, createHeading, createMinimalOptionRenderer, createMinimalParameterRenderer, createMinimalParamLabelRenderer, createShortOptionArityAndNameComparator, createShortOptionNameComparator, createTextTable, customSynopsis, defaultColorScheme, description, descriptionHeading, detailedSynopsis, detailedSynopsis, endOfOptionsList, exitCodeList, exitCodeListHeading, footer, footerHeading, fullSynopsis, hasAtFileParameter, header, headerHeading, insertSynopsisCommandName, join, join, optionList, optionList, optionListExcludingGroups, optionListExcludingGroups, optionListGroupSections, optionListHeading, optionSectionGroups, parameterLabelRenderer, parameterList, parameterList, parameterList, parameterList, parameterListHeading, shortestFirst, subcommands, synopsis, synopsisHeading, synopsisHeadingLength

      Methods inherited from class java.lang.Object

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

    • Constructor Details

      • CustomHelp

        public CustomHelp(picocli.CommandLine.Model.CommandSpec commandSpec, picocli.CommandLine.Help.ColorScheme colorScheme)

    • Method Details

      • synopsis

        public String synopsis(int synopsisHeadingLength)
        Override this to set custom options compatarator and clusterBooleanOptions parameter to false.
        Overrides:
        synopsis in class picocli.CommandLine.Help

      • makeSynopsisFromParts

        protected String makeSynopsisFromParts(int synopsisHeadingLength, picocli.CommandLine.Help.Ansi.Text optionText, picocli.CommandLine.Help.Ansi.Text groupsText, picocli.CommandLine.Help.Ansi.Text endOfOptionsText, picocli.CommandLine.Help.Ansi.Text positionalParamText, picocli.CommandLine.Help.Ansi.Text commandText)
        Override this to switch positions of groupsText and optionText.
        Overrides:
        makeSynopsisFromParts in class picocli.CommandLine.Help