org.freehep.util.argv
Interface Parameter

All Known Implementing Classes:

ListParameter, NumberParameter, StringParameter

public interface Parameter

Interface for parameters that may be registered and parsed by the ArgumentParser.

Source Code:

Parameter.java

Method Summary

String	getName() Must return name of the parameter.
String	getUsage() Must return a description of the usage of this parameter.
int	parse(List values) Must check for a parameter.

Method Detail

parse

public int parse(List values)
          throws MissingArgumentException,
                 ArgumentFormatException

Must check for a parameter. This method must return the number of arguments belonging to this parameter (normally one, but more for lists). ArgumentParser.parse( values ) will invoke this method once for each possible starting position of this parameter in values.

Throws:

MissingArgumentException

ArgumentFormatException

getName

public String getName()

Must return name of the parameter.

getUsage

public String getUsage()

Must return a description of the usage of this parameter.