Class HtmlCommandUsageGenerator

    • Field Detail

      • DEFAULT_STYLESHEET

        public static final java.lang.String DEFAULT_STYLESHEET
        Default stylesheet (Bootstrap)
        See Also:
        Constant Field Values
      • NEWLINE

        protected static final java.lang.String NEWLINE
        Constant for a new line (using a <br> )
        See Also:
        Constant Field Values
      • stylesheetUrls

        protected final java.util.List<java.lang.String> stylesheetUrls
        List of stylesheet URLs
    • Constructor Detail

      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator()
      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator​(boolean includeHidden)
      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator​(java.lang.String... stylesheetUrls)
      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator​(boolean includeHidden,
                                         java.lang.String... stylesheetUrls)
      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator​(java.lang.String stylesheetUrl,
                                         boolean includeHidden)
      • HtmlCommandUsageGenerator

        public HtmlCommandUsageGenerator​(java.util.Comparator<? super OptionMetadata> optionComparator,
                                         boolean includeHidden,
                                         java.lang.String... stylesheetUrls)
    • Method Detail

      • usage

        public <T> void usage​(java.lang.String programName,
                              java.lang.String[] groupNames,
                              java.lang.String commandName,
                              CommandMetadata command,
                              ParserMetadata<T> parserConfig,
                              java.io.OutputStream output)
                       throws java.io.IOException
        Description copied from interface: CommandUsageGenerator
        Generate the help and output it to the stream
        Type Parameters:
        T - Command type
        Parameters:
        programName - Program Name
        groupNames - Group Name(s)
        commandName - Command Name
        command - Command Metadata
        parserConfig - Parser Configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help
        output - Stream to output to
        Throws:
        java.io.IOException - Thrown if there is a problem generating usage output
      • outputOptions

        protected <T> void outputOptions​(java.io.Writer writer,
                                         java.util.List<OptionMetadata> options,
                                         ArgumentsMetadata arguments,
                                         ParserMetadata<T> parserConfig)
                                  throws java.io.IOException
        Outputs a documentation section detailing the options
        Parameters:
        writer - Writer
        options - Option meta-data
        Throws:
        java.io.IOException
      • outputOptionRestriction

        protected void outputOptionRestriction​(java.io.Writer writer,
                                               OptionMetadata option,
                                               OptionRestriction restriction,
                                               HelpHint hint)
                                        throws java.io.IOException
        Outputs a documentation section detailing an allowed value for an option
        Parameters:
        writer - Writer
        option - Option meta-data
        restriction - Restriction
        hint - Help hint
        Throws:
        java.io.IOException
      • outputHelpSection

        protected void outputHelpSection​(java.io.Writer writer,
                                         HelpSection section)
                                  throws java.io.IOException
        Outputs a help section
        Parameters:
        writer - Writer
        section - Help section
        Throws:
        java.io.IOException
      • outputHelpHint

        protected void outputHelpHint​(java.io.Writer writer,
                                      HelpHint hint)
                               throws java.io.IOException
        Outputs a help hint
        Parameters:
        writer - Writer
        hint - Help hint
        Throws:
        java.io.IOException
      • outputSynopsis

        protected java.util.List<OptionMetadata> outputSynopsis​(java.io.Writer writer,
                                                                java.lang.String programName,
                                                                java.lang.String[] groupNames,
                                                                CommandMetadata command)
                                                         throws java.io.IOException
        Outputs a documentation section with a synopsis of the command
        Parameters:
        writer - Writer
        programName - Program name
        groupNames - Group name(s)
        command - Command name
        Returns:
        List of all the available options (Global, Group and Command)
        Throws:
        java.io.IOException
      • outputDescription

        protected void outputDescription​(java.io.Writer writer,
                                         java.lang.String programName,
                                         java.lang.String[] groupNames,
                                         CommandMetadata command)
                                  throws java.io.IOException
        Outputs a documentation section with the name and description of the command
        Parameters:
        writer - Writer
        programName - Program name
        groupNames - Group name(s)
        command - Command meta-data
        Throws:
        java.io.IOException
      • outputPageHeader

        protected void outputPageHeader​(java.io.Writer writer,
                                        java.lang.String programName,
                                        java.lang.String[] groupNames,
                                        CommandMetadata command)
                                 throws java.io.IOException
        Outputs a page header
        Parameters:
        writer - Writer
        programName - Program name
        groupNames - Group name(s)
        command - Command meta-data
        Throws:
        java.io.IOException
      • outputHtmlHeader

        protected void outputHtmlHeader​(java.io.Writer writer)
                                 throws java.io.IOException
        Outputs the HTML header for the page
        Parameters:
        writer - Writer
        Throws:
        java.io.IOException
      • outputAdditionalCss

        protected void outputAdditionalCss​(java.io.Writer writer)
                                    throws java.io.IOException
        Outputs additional CSS directly
        Parameters:
        writer - Writer
        Throws:
        java.io.IOException
      • outputStylesheets

        protected void outputStylesheets​(java.io.Writer writer)
                                  throws java.io.IOException
        Outputs the style sheet declarations
        Parameters:
        writer - Writer
        Throws:
        java.io.IOException