Tool (Solr 9.9.0 core API)

All Known Implementing Classes:

ApiTool, AssertTool, AuthTool, ClusterTool, ConfigSetDownloadTool, ConfigSetUploadTool, ConfigTool, CreateTool, DeleteTool, ExportTool, HealthcheckTool, LinkConfigTool, PackageTool, PostLogsTool, PostTool, RunExampleTool, SnapshotCreateTool, SnapshotDeleteTool, SnapshotDescribeTool, SnapshotExportTool, SnapshotListTool, StatusTool, ToolBase, UpdateACLTool, VersionTool, ZkCpTool, ZkLsTool, ZkMkrootTool, ZkMvTool, ZkRmTool, ZkToolHelp
```
public interface Tool
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`getFooter()`	Optional footer to display after the options in help output.
`default String`	`getHeader()`	Optional header to display before the options in help output.
`String`	`getName()`	Defines the interface to a Solr tool that can be run from this command-line app.
`List<org.apache.commons.cli.Option>`	`getOptions()`
`ToolRuntime`	`getRuntime()`	Return non-null runtime of the tool.
`default String`	`getUsage()`	Provides a Usage string to display in help output.
`int`	`runTool(org.apache.commons.cli.CommandLine cli)`

- 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
  - getRuntime
```
ToolRuntime getRuntime()
```
    Return non-null runtime of the tool.
  - getOptions
```
List<org.apache.commons.cli.Option> getOptions()
```
  - runTool
```
int runTool(org.apache.commons.cli.CommandLine cli)
     throws Exception
```
    Throws:
    
    Exception