Method printToolHelp

solr/core/src/java/org/apache/solr/cli/SolrCLI.java:296–312

Prints tool help for a given tool

(Tool tool)

  }

  /** Prints tool help for a given tool */
  public static void printToolHelp(Tool tool) throws IOException {
    HelpFormatter formatter = getFormatter();
    Options nonDeprecatedOptions = new Options();

    tool.getOptions().getOptions().stream()
        .filter(option -> !option.isDeprecated())
        .forEach(nonDeprecatedOptions::addOption);

    String usageString = tool.getUsage() == null ? "bin/solr " + tool.getName() : tool.getUsage();
    boolean autoGenerateUsage = tool.getUsage() == null;
    formatter.printHelp(
        usageString,
        "\n" + tool.getHeader(),
        nonDeprecatedOptions,
        tool.getFooter(),
        autoGenerateUsage);
  }

  @SuppressForbidden(reason = "System.out for formatting")