|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter<List<T>,List<T>> de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter<Class<? extends C>> de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ClassListParameter<C>
C
- Class typepublic class ClassListParameter<C>
Parameter class for a parameter specifying a list of class names.
Field Summary | |
---|---|
protected Class<C> |
restrictionClass
The restriction class for the list of class names. |
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter |
---|
LIST_SEP, SPLIT, VECTOR_SEP, VECTOR_SPLIT |
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter |
---|
constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription |
Constructor Summary | |
---|---|
ClassListParameter(OptionID optionID,
Class<?> restrictionClass)
Constructs a class list parameter with the given optionID and restriction class. |
|
ClassListParameter(OptionID optionID,
Class<?> restrictionClass,
boolean optional)
Constructs a class list parameter with the given optionID and restriction class. |
Method Summary | |
---|---|
IterableIterator<Class<?>> |
getKnownImplementations()
Get an iterator over all known implementations of the class restriction. |
Class<C> |
getRestrictionClass()
Returns the restriction class of this class parameter. |
String[] |
getRestrictionClasses()
Returns the class names allowed according to the restriction class of this parameter. |
String |
getSyntax()
Returns a string representation of the parameter's type. |
String |
getValueAsString()
Get the value as string. |
String |
getValuesDescription()
Return a description of known valid classes. |
boolean |
hasValuesDescription()
This class sometimes provides a list of value descriptions. |
List<C> |
instantiateClasses(Parameterization config)
Returns a list of new instances for the value (i.e., the class name) of this class list parameter. |
protected List<Class<? extends C>> |
parseValue(Object obj)
Parse a given value into the destination type. |
String |
restrictionString()
Provides a description string listing all classes for the given superclass or interface as specified in the properties. |
protected boolean |
validate(List<Class<? extends C>> obj)
Validate a value after parsing (e.g. do constrain checks!) |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ListParameter |
---|
asString, getListSize |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter |
---|
addConstraint, getDefaultValue, getDefaultValueAsString, getFullDescription, getGivenValue, getName, getOptionID, getShortDescription, getValue, hasDefaultValue, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Class<C> restrictionClass
Constructor Detail |
---|
public ClassListParameter(OptionID optionID, Class<?> restrictionClass, boolean optional)
optionID
- the unique id of this parameterrestrictionClass
- the restriction class of the list of class namesoptional
- specifies if this parameter is an optional parameterpublic ClassListParameter(OptionID optionID, Class<?> restrictionClass)
optionID
- the unique id of this parameterrestrictionClass
- the restriction class of the list of class namesMethod Detail |
---|
public String getValueAsString()
null
getValueAsString
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
protected List<Class<? extends C>> parseValue(Object obj) throws ParameterException
parseValue
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
obj
- Object to parse (may be a string representation!)
ParameterException
- when the object cannot be parsed.protected boolean validate(List<Class<? extends C>> obj) throws ParameterException
validate
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
obj
- Object to validate
ParameterException
- when the object is not valid.public Class<C> getRestrictionClass()
public IterableIterator<Class<?>> getKnownImplementations()
Iterable
and Iterator
objectpublic String[] getRestrictionClasses()
public String getSyntax()
getSyntax
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
public List<C> instantiateClasses(Parameterization config)
config
- Parameterization to use (if Parameterizable))
public String restrictionString()
public boolean hasValuesDescription()
hasValuesDescription
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
Parameter.hasValuesDescription()
public String getValuesDescription()
getValuesDescription
in class Parameter<List<Class<? extends C>>,List<Class<? extends C>>>
Parameter.getValuesDescription()
|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |