Class BaseCommand

java.lang.Object
  BaseCommand

public abstract class BaseCommand
extends java.lang.Object

Contains methods common to all types of chat commands.

Field Summary

Modifier and Type	Field and Description
java.lang.String	errorMessage
int	maxParam
int	minParam
java.lang.String	tooltip

Constructor and Description

BaseCommand(java.lang.String tooltip)

BaseCommand(java.lang.String tooltip, java.lang.String errorMessage, int minParam)

BaseCommand(java.lang.String tooltip, java.lang.String errorMessage, int minParam, int maxParam)

Method Summary

Modifier and Type	Method and Description
void	onBadSyntax(MessageReceiver caller, java.lang.String[] parameters)
boolean	parseCommand(MessageReceiver caller, java.lang.String[] parameters)

Methods inherited from class java.lang.Object

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

Field Detail

tooltip

public final java.lang.String tooltip

errorMessage

public final java.lang.String errorMessage

minParam

public final int minParam

maxParam

public final int maxParam

Constructor Detail

BaseCommand

public BaseCommand(java.lang.String tooltip)

BaseCommand

public BaseCommand(java.lang.String tooltip,
                   java.lang.String errorMessage,
                   int minParam)

BaseCommand

public BaseCommand(java.lang.String tooltip,
                   java.lang.String errorMessage,
                   int minParam,
                   int maxParam)

Method Detail

parseCommand

public boolean parseCommand(MessageReceiver caller,
                            java.lang.String[] parameters)

onBadSyntax

public void onBadSyntax(MessageReceiver caller,
                        java.lang.String[] parameters)