CliCommand (Dumpling CLI 2.2 API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

BlockingTreeCommand, DeadlocksCommand, GrepCommand, GroovyCommand, GroovyshCommand, HelpCommand, ThreaddumpCommand, TopContendersCommand
```
public interface CliCommand
```
CLI handler, usually a query invoker. Used to make queries available though CLI. Command arguments are bound using args4j.

Author:

ogondza

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Get one-line description of command.
`String`	`getName()` Name of the command.
`int`	`run(ProcessStream process)` Invoke the command.

- Method Detail
  - getName
```
@Nonnull
String getName()
```
    Name of the command.
  - getDescription
```
@Nonnull
String getDescription()
```
    Get one-line description of command.
  - run
```
int run(@Nonnull
      ProcessStream process)
        throws org.kohsuke.args4j.CmdLineException
```
    Invoke the command.
    
    Returns:
    Command return code.
    
    Throws:
    
    org.kohsuke.args4j.CmdLineException

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2016. All rights reserved.