com.jmodule.def

Class CommandLogic

java.lang.Object

com.jmodule.def.CommandLogic

public abstract class CommandLogic
extends java.lang.Object

Classes extending this class can define the logic for commands based on user input, if given. You can also define the standard parameters for your command logic. Subclasses of this class are taken as a parameter when instantiating a command

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
CommandLogic()
CommandLogic(java.lang.String[] params)

Method Summary

Modifier and Type	Method and Description
CommandLogic	addOption(Option t) Adds a possible option to the command.
abstract void	execute(java.lang.String[] args) Override this method to define the logic for a command.
java.util.ArrayList<Option>	getOptions()
java.lang.String[]	getParams()
boolean	onOption(char flag) Use this method in an if-statement as such:

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLogic

public CommandLogic()

CommandLogic

public CommandLogic(java.lang.String[] params)

Method Detail

getOptions

public java.util.ArrayList<Option> getOptions()

getParams

public java.lang.String[] getParams()

execute

public abstract void execute(java.lang.String[] args)

Override this method to define the logic for a command.

Parameters:

args - Command-line arguments

onOption

public boolean onOption(char flag)

Use this method in an if-statement as such:

 
  @Override
 public void execute() {
 ...
        if (onOption('a')) {
                 // behavior with option 'a'
        }
        if (onOption('b')) {
                 // behavior with option 'b'
        }
 }
 
 

to signify the execution of the command when different options are called in addition to the command's parameters.

Parameters:

flag - The option's one-character reference (Example: "-a" or "-b")

Returns:

true if the option exists and is called either by its flag or one of its references, false otherwise.

addOption

public CommandLogic addOption(Option t)

Adds a possible option to the command.

Parameters:

t - Default flag to call the option

Returns:

This instance of CommandLogic