|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.cli2.validation.EnumValidator
public class EnumValidator
The EnumValidator
validates the string argument
values are valid.
The following example shows how to limit the valid values
for the color argument to 'red', 'green', or 'blue'.
Set values = new HashSet(); values.add("red"); values.add("green"); values.add("blue"); ... ArgumentBuilder builder = new ArgumentBuilder(); Argument color = builder.withName("color"); .withValidator(new EnumValidator(values));
Field Summary | |
---|---|
private java.util.Set |
validValues
List of permitted values |
Constructor Summary | |
---|---|
EnumValidator(java.util.Set values)
Creates a new EnumValidator for the specified values. |
Method Summary | |
---|---|
java.util.Set |
getValidValues()
Returns the Set of valid argument values. |
(package private) java.lang.String |
getValuesAsString()
Returns the permitted values in a comma separated String |
protected void |
setValidValues(java.util.Set validValues)
Specifies the Set of valid argument values. |
void |
validate(java.util.List values)
Validate the list of values against the list of permitted values. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.util.Set validValues
Constructor Detail |
---|
public EnumValidator(java.util.Set values)
values
- The list of permitted valuesMethod Detail |
---|
public void validate(java.util.List values) throws InvalidArgumentException
validate
in interface Validator
values
- The values to validate.
InvalidArgumentException
- If any of the
specified values are not valid.Validator.validate(java.util.List)
java.lang.String getValuesAsString()
public java.util.Set getValidValues()
protected void setValidValues(java.util.Set validValues)
validValues
- The Set of valid argument values.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |