|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.cli2.validation.ClassValidator
public class ClassValidator
The ClassValidator
validates the string argument
values are class names.
The following example shows how to validate the 'logger'
argument value is a class name, that can be instantiated.
... ClassValidator validator = new ClassValidator(); validator.setInstance(true); ArgumentBuilder builder = new ArgumentBuilder(); Argument logger = builder.withName("logger"); .withValidator(validator);
Field Summary | |
---|---|
private boolean |
instance
whether to create an instance of the class |
private boolean |
loadable
whether the class argument is loadable |
private java.lang.ClassLoader |
loader
the classloader to load classes from |
private static ResourceHelper |
resources
i18n |
Constructor Summary | |
---|---|
ClassValidator()
|
Method Summary | |
---|---|
java.lang.ClassLoader |
getClassLoader()
Returns the ClassLoader used to resolve and load
the classes specified by the argument values. |
boolean |
isInstance()
Returns whether the argument value must represent a class that can be instantiated. |
boolean |
isLoadable()
Returns whether the argument value must represent a class that is loadable. |
protected boolean |
isPotentialClassName(java.lang.String name)
Returns whether the specified name is allowed as a Java class name. |
void |
setClassLoader(java.lang.ClassLoader loader)
Specifies the ClassLoader used to resolve and load
the classes specified by the argument values. |
void |
setInstance(boolean instance)
Specifies whether the argument value must represent a class that can be instantiated. |
void |
setLoadable(boolean loadable)
Specifies whether the argument value must represent a class that is loadable. |
void |
validate(java.util.List values)
Validate each argument value in the specified List against this instances permitted attributes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final ResourceHelper resources
private boolean loadable
private boolean instance
private java.lang.ClassLoader loader
Constructor Detail |
---|
public ClassValidator()
Method Detail |
---|
public void validate(java.util.List values) throws InvalidArgumentException
String
value in the list is
replaced with it's Class
value or instance.
validate
in interface Validator
values
- The values to validate.
InvalidArgumentException
- If any of the
specified values are not valid.Validator.validate(java.util.List)
public boolean isLoadable()
public void setLoadable(boolean loadable)
loadable
- whether the argument value must
represent a class that is loadable.public java.lang.ClassLoader getClassLoader()
ClassLoader
used to resolve and load
the classes specified by the argument values.
ClassLoader
used to resolve and load
the classes specified by the argument values.public void setClassLoader(java.lang.ClassLoader loader)
ClassLoader
used to resolve and load
the classes specified by the argument values.
loader
- the ClassLoader
used to resolve and load
the classes specified by the argument values.public boolean isInstance()
public void setInstance(boolean instance)
instance
- whether the argument value must
represent a class that can be instantiated.protected boolean isPotentialClassName(java.lang.String name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |