org.obolibrary.robot

Class ExplainCommand

java.lang.Object

org.obolibrary.robot.ExplainCommand

All Implemented Interfaces:

Command

public class ExplainCommand
extends Object
implements Command

Handles inputs and outputs for the ExplainOperation.

Author:

Jim Balhoff

Field Summary

Fields inherited from interface org.obolibrary.robot.Command

global, missingFileError

Constructor Summary

Constructors

Constructor and Description
ExplainCommand()

Method Summary

Modifier and Type	Method and Description
CommandState	execute(CommandState state, String[] args) All commands offer an execute method that can be chained from previous commands.
String	getDescription() Brief description of the command.
String	getName() Name of the command.
org.apache.commons.cli.Options	getOptions() Command-line options for the command.
String	getUsage() Command-line usage for the command.
void	main(String[] args) Handle the command-line and file operations for the ExplainOperation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplainCommand

public ExplainCommand()

Method Detail

getName

public String getName()

Description copied from interface: Command

Name of the command.

Specified by:

getName in interface Command

Returns:

name

getDescription

public String getDescription()

Description copied from interface: Command

Brief description of the command.

Specified by:

getDescription in interface Command

Returns:

description

getUsage

public String getUsage()

Description copied from interface: Command

Command-line usage for the command.

Specified by:

getUsage in interface Command

Returns:

usage

getOptions

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

Description copied from interface: Command

Command-line options for the command.

Specified by:

getOptions in interface Command

Returns:

options

main

public void main(String[] args)

Handle the command-line and file operations for the ExplainOperation.

Specified by:

main in interface Command

Parameters:

args - strings to use as arguments

execute

public CommandState execute(CommandState state,
                            String[] args)
                     throws Exception

Description copied from interface: Command

All commands offer an execute method that can be chained from previous commands.

Specified by:

execute in interface Command

Parameters:

state - the input from the previous command, or null

args - the command-line arguments

Returns:

the updated state, or a new state, or null

Throws:

Exception - on any problem