Interface Tool

    • Method Detail

      • getName

        String getName()
        Defines the interface to a Solr tool that can be run from this command-line app.
      • getUsage

        default String getUsage()
        Provides a Usage string to display in help output. Defaults to auto generating usage string. Override for custom string
        Returns:
        The custom usage string or 'null' to auto generate (default)
      • getHeader

        default String getHeader()
        Optional header to display before the options in help output. Defaults to 'List of options:'
      • getFooter

        default String getFooter()
        Optional footer to display after the options in help output. Defaults to a link to reference guide
      • getOptions

        List<org.apache.commons.cli.Option> getOptions()
      • runTool

        int runTool​(org.apache.commons.cli.CommandLine cli)
             throws Exception
        Throws:
        Exception