Class Help


  • public final class Help
    extends picocli.CommandLine.Help
    • Nested Class Summary

      • 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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      picocli.CommandLine.Help.Layout createDefaultLayout()  
      picocli.CommandLine.Help.IOptionRenderer createDefaultOptionRenderer()  
      picocli.CommandLine.Help.IParameterRenderer createDefaultParameterRenderer()  
      String createHeading​(String text, Object... params)  
      List<picocli.CommandLine.Model.ArgGroupSpec> optionSectionGroups()  
      void setAllOptions​(boolean allOptions)  
      • Methods inherited from class picocli.CommandLine.Help

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

      • createDefaultLayout

        public picocli.CommandLine.Help.Layout createDefaultLayout()
        Overrides:
        createDefaultLayout in class picocli.CommandLine.Help
      • createDefaultOptionRenderer

        public picocli.CommandLine.Help.IOptionRenderer createDefaultOptionRenderer()
        Overrides:
        createDefaultOptionRenderer in class picocli.CommandLine.Help
      • createHeading

        public String createHeading​(String text,
                                    Object... params)
        Overrides:
        createHeading in class picocli.CommandLine.Help
      • createDefaultParameterRenderer

        public picocli.CommandLine.Help.IParameterRenderer createDefaultParameterRenderer()
        Overrides:
        createDefaultParameterRenderer in class picocli.CommandLine.Help
      • optionSectionGroups

        public List<picocli.CommandLine.Model.ArgGroupSpec> optionSectionGroups()
        Overrides:
        optionSectionGroups in class picocli.CommandLine.Help
      • setAllOptions

        public void setAllOptions​(boolean allOptions)