net.sourceforge.argparse4j.inf

Interface ArgumentChoice

All Known Implementing Classes:

CollectionArgumentChoice, RangeArgumentChoice

public interface ArgumentChoice

This interface defines simple data validation method.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object val) Returns true iff val is valid choice according to this object's constraint.
String	textualFormat() Return textual representation of this choice.

Method Detail

contains

boolean contains(Object val)

Returns true iff val is valid choice according to this object's constraint.

If the objects derived from RuntimeException are thrown because of invalid input from command line, subclass must catch these exceptions and return false.

Parameters:

val - The attribute value.

Returns:

true or false.

textualFormat

String textualFormat()

Return textual representation of this choice.

This string will be used in help and error messages.

Returns:

The textual representation of this choice.