org.apache.ratis.shell.cli

接口 Command

所有超级接口:

AutoCloseable, Closeable, Comparable<Command>

所有已知实现类:

AbstractCommand, AbstractParentCommand, AbstractRatisCommand, AddCommand, ElectionCommand, GroupCommand, GroupInfoCommand, GroupListCommand, LocalCommand, PauseCommand, PeerCommand, RaftMetaConfCommand, RemoveCommand, ResumeCommand, SetPriorityCommand, SnapshotCommand, StepDownCommand, TakeSnapshotCommand, TransferCommand

public interface Command
extends Comparable<Command>, Closeable

An interface for all the commands that can be run from a shell.

方法概要

限定符和类型	方法和说明
default void	close() Used to close resources created by commands.
default int	compareTo(Command that)
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
default org.apache.commons.cli.Options	getOptions()
default Map<String,Command>	getSubCommands()
String	getUsage()
default boolean	hasSubCommand() If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.
default org.apache.commons.cli.CommandLine	parseAndValidateArgs(String... args) Parses and validates the arguments.
default int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
default void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

方法详细资料

getCommandName

String getCommandName()

Gets the command name as input from the shell.

返回:

the command name

compareTo

default int compareTo(Command that)

指定者:

compareTo 在接口中 Comparable<Command>

getOptions

default org.apache.commons.cli.Options getOptions()

返回:

the supported Options of the command

hasSubCommand

default boolean hasSubCommand()

If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.

返回:

whether this command has sub-commands

getSubCommands

default Map<String,Command> getSubCommands()

返回:

a map from sub-command names to sub-command instances

parseAndValidateArgs

default org.apache.commons.cli.CommandLine parseAndValidateArgs(String... args)
                                                         throws IllegalArgumentException

Parses and validates the arguments.

参数:

args - the arguments for the command, excluding the command name

返回:

the parsed command line object

抛出:

IllegalArgumentException - when arguments are not valid

validateArgs

default void validateArgs(org.apache.commons.cli.CommandLine cl)
                   throws IllegalArgumentException

Checks if the arguments are valid or throw InvalidArgumentException.

参数:

cl - the parsed command line for the arguments

抛出:

IllegalArgumentException - when arguments are not valid

run

default int run(org.apache.commons.cli.CommandLine cl)
         throws IOException

Runs the command.

参数:

cl - the parsed command line for the arguments

返回:

the result of running the command

抛出:

IOException

getUsage

String getUsage()

返回:

the usage information of the command

getDescription

String getDescription()

返回:

the description information of the command

close

default void close()
            throws IOException

Used to close resources created by commands.

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable

抛出:

IOException - if closing resources fails