com.jmodule.def

Class Command

java.lang.Object

com.jmodule.def.Command

Direct Known Subclasses:

IndefiniteCommand

public class Command
extends java.lang.Object

Represents a possible command. A command can have multiple references, or ways to call it from the command line. For example, a "find" command that can be accessed by typing 'find' or just 'fd' on the command line would have 'fd' as an alternate reference. A command can also have any number of defined parameters and command-specific logic to process the given parameters.

A command's logic and possible parameters are defined by writing a logic class extending CommandLogic. For more information about CommandLogic, consult the CommandLogic documentation

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
Command(java.lang.String name, java.lang.String description, CommandLogic logic) Sets the name of the command function (for example, "find" or "grep") and inherits parameters from command logic, if any.

Method Summary

Modifier and Type	Method and Description
void	addReference(java.lang.String reference) Adds a possible reference to the command
void	appendUsage(java.lang.String append) Adds additional information to the command's usage info
java.lang.String	getDefaultReference()
java.lang.String	getDescription()
java.lang.String	getName()
java.util.ArrayList<java.lang.String>	getReferences()
java.lang.String	getUsage() Gives the correct usage in a standard, user-friendly format
void	resetUsage(java.lang.String reset) Replaces the command's usage info with a given String
void	run(java.lang.String[] args) Runs the command logic with the given arguments

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(java.lang.String name,
               java.lang.String description,
               CommandLogic logic)

Sets the name of the command function (for example, "find" or "grep") and inherits parameters from command logic, if any. Sets the default reference based on the command's name

Parameters:

name - Command name

description - Command description

logic - Command logic

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getDefaultReference

public java.lang.String getDefaultReference()

getReferences

public java.util.ArrayList<java.lang.String> getReferences()

addReference

public void addReference(java.lang.String reference)

Adds a possible reference to the command

Parameters:

reference -

getUsage

public java.lang.String getUsage()

Gives the correct usage in a standard, user-friendly format

Returns:

usage statment

appendUsage

public void appendUsage(java.lang.String append)

Adds additional information to the command's usage info

Parameters:

append - Information to append to usage

resetUsage

public void resetUsage(java.lang.String reset)

Replaces the command's usage info with a given String

Parameters:

reset - New usage info to display

run

public void run(java.lang.String[] args)

Runs the command logic with the given arguments

Parameters:

args - Command-line arguments