ch.icosys.popjava.core.scripts.shell

Class CommandInfo

java.lang.Object

ch.icosys.popjava.core.scripts.shell.CommandInfo

public class CommandInfo
extends java.lang.Object

Describe a command for the main POPJShell

Constructor Summary

Constructors

Constructor and Description
CommandInfo(java.lang.String line) Transform a line into its components

Method Summary

Modifier and Type	Method and Description
CommandInfo	advance() Replace the keyword with the first parameter in params.
boolean	canAdvance() Report if we can advance the command one (1) step.
Parameter	extractParameter(ParameterInfo... expected) Extract the parameters from the remaining arguments.
java.lang.String	getKeyword() The keyword for this command.
java.lang.String[]	getParams() A copy of the remaining parameters.
boolean	isNextHelp() Does the command ask to call for help?

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandInfo

public CommandInfo(java.lang.String line)

Transform a line into its components

Parameters:

line - the line to read

Method Detail

extractParameter

public Parameter extractParameter(ParameterInfo... expected)

Extract the parameters from the remaining arguments.

Parameters:

expected - a series of parameters we can extract later

Returns:

the object where we can extract the parameters

advance

public CommandInfo advance()

Replace the keyword with the first parameter in params. Before calling this method, check if you can with canAdvance().

Returns:

a new CommandInfo or null in can it can't advance anymore.

canAdvance

public boolean canAdvance()

Report if we can advance the command one (1) step.

Returns:

true if we can, false if we can't.

isNextHelp

public boolean isNextHelp()

Does the command ask to call for help?

Returns:

true if help is requested

getKeyword

public java.lang.String getKeyword()

The keyword for this command.

Returns:

the command keyword

getParams

public java.lang.String[] getParams()

A copy of the remaining parameters.

Returns:

the command parameters