org.xith3d.utility.cmdline
Interface CommandPatternInterface

All Known Implementing Classes:

SimpleCommandPattern

public interface CommandPatternInterface

Method Summary

java.lang.String	getKey() This is used to match against the first token in the command line.
java.lang.String	getName()
CommandParameters	getParameters(CommandLine line)
boolean	match(CommandLine line)

Method Detail

match

boolean match(CommandLine line)

Parameters:

line -

Returns:

true if the command line matches this pattern.

getParameters

CommandParameters getParameters(CommandLine line)

Parameters:

line -

Returns:

the parameters from a commandline once a match has been found. This will attempt to turn all the parameters into the correct type. If the parameters fail to convert then an exception will be thrown.

getKey

java.lang.String getKey()

This is used to match against the first token in the command line. This is meant to be used to isolate those commands which start with same word like /loot or /info so that more powerful (and slower) match checks can take place.

getName

java.lang.String getName()