com.jmodule.def

Class BoundedCommand

java.lang.Object

com.jmodule.def.Command

com.jmodule.def.IndefiniteCommand

com.jmodule.def.BoundedCommand

public class BoundedCommand
extends IndefiniteCommand

Represents a command with a certain minimum and maximum number of parameters. This subclass of IndefCommand can either be instantiated with (name, description, logic, min) to leave the maximum bound unspecified or (name, description, logic, min, max) to define both bounds of the range.

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
BoundedCommand(java.lang.String name, java.lang.String description, CommandLogic logic, int min) Construcs a bounded command with a minimum number of parameters
BoundedCommand(java.lang.String name, java.lang.String description, CommandLogic logic, int min, int max) Construcs a bounded command with a minimum and maximum number of parameters

Method Summary

Methods inherited from class com.jmodule.def.Command

addReference, appendUsage, getDefaultReference, getDescription, getName, getReferences, getUsage, resetUsage, run

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedCommand

public BoundedCommand(java.lang.String name,
                      java.lang.String description,
                      CommandLogic logic,
                      int min)

Construcs a bounded command with a minimum number of parameters

Parameters:

name - Command name

description - Command description

logic - Command logic

min - Minimum number of parameters

BoundedCommand

public BoundedCommand(java.lang.String name,
                      java.lang.String description,
                      CommandLogic logic,
                      int min,
                      int max)

Construcs a bounded command with a minimum and maximum number of parameters

Parameters:

name - Command name

description - Command description

logic - Command logic

min - Minimum number of parameters

max - Maximum number of paramters