fr.inria.opengve.tools
Class CommandLineParse.StringParameter

java.lang.Object
  fr.inria.opengve.tools.CommandLineParse.StringParameter

Enclosing class:

CommandLineParse

public class CommandLineParse.StringParameter
extends java.lang.Object

Method Summary

void	addExclusiveParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter exclusiveParameter) Add an existing parameter to the set of parameters that are exclusive with this one and vice versa.
java.lang.String	getStringValue() Return the string value of this option.
boolean	isFound() Tell if this option have been found in the command line.
void	setExplanation(java.lang.String explanation) Set the explanation of this option.
fr.inria.opengve.tools.CommandLineParse.CommandLineParameter	testExclusivity() Test if this parameters is exclusive with a previously found parameters.
java.lang.String	toString() Return the string corresponding to the long Name of this option.

Methods inherited from class java.lang.Object

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

Method Detail

getStringValue

public java.lang.String getStringValue()

Return the string value of this option.

Returns:

The value of this option.

isFound

public boolean isFound()

Tell if this option have been found in the command line.

Returns:

true if this option have been found, and false otherwise.

setExplanation

public void setExplanation(java.lang.String explanation)

Set the explanation of this option.

Parameters:

explanation - The explanation of this option.

toString

public java.lang.String toString()

Return the string corresponding to the long Name of this option.

Overrides:

toString in class java.lang.Object

addExclusiveParameter

public void addExclusiveParameter(fr.inria.opengve.tools.CommandLineParse.CommandLineParameter exclusiveParameter)

Add an existing parameter to the set of parameters that are exclusive with this one and vice versa.

Parameters:

exclusiveParameter - The parameters that is declared exclusive with this one.

testExclusivity

public fr.inria.opengve.tools.CommandLineParse.CommandLineParameter testExclusivity()

Test if this parameters is exclusive with a previously found parameters.

Returns:

The CommandLineParse.CommandLineParameter that is exclusive with this one (and that is already found) or null if no one exist.