ListParameter (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.utilities.optionhandling.parameters.AbstractParameter<P,T>
- - elki.utilities.optionhandling.parameters.ListParameter<P,T>

Type Parameters:

P - Type self-reference

T - List type

All Implemented Interfaces:

Parameter<T>

Direct Known Subclasses:

ClassListParameter, DoubleArrayListParameter, DoubleListParameter, FileListParameter, IntListParameter
```
public abstract class ListParameter<P extends ListParameter<P,T>,T>
extends AbstractParameter<P,T>
```
Abstract parameter class defining a parameter for a list of objects.

Since:

0.1

Author:

Steffi Wanka, Erich Schubert

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`LIST_SEP`	List separator character - ":"
`static java.util.regex.Pattern`	`SPLIT`	A pattern defining a ",".
`static java.lang.String`	`VECTOR_SEP`	Vector separator character - ":"
`static java.util.regex.Pattern`	`VECTOR_SPLIT`	A pattern defining a ":" or ";".

Fields inherited from class elki.utilities.optionhandling.parameters.AbstractParameter
constraints, defaultValue, givenValue, optionalParameter, optionid

Constructor Summary

Constructors
Constructor	Description
`ListParameter(OptionID optionID)`	Constructs a list parameter with the given optionID.
`ListParameter(OptionID optionID, T defaultValue)`	Constructs a list parameter with the given optionID.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method Description

abstract int size()
Size of the list.
- Methods inherited from class elki.utilities.optionhandling.parameters.AbstractParameter
  addConstraint, describeValues, getConstraints, getDefaultValue, getDefaultValueAsString, getOptionID, getValue, hasDefaultValue, isDefined, isOptional, isValid, parseValue, setDefaultValue, setOptional, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, validate
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface elki.utilities.optionhandling.parameters.Parameter
  getSyntax, getValueAsString

- Field Detail
  - SPLIT
```
public static final java.util.regex.Pattern SPLIT
```
    A pattern defining a ",".
  - LIST_SEP
```
public static final java.lang.String LIST_SEP
```
    List separator character - ":"
    
    See Also:
    
    Constant Field Values
  - VECTOR_SPLIT
```
public static final java.util.regex.Pattern VECTOR_SPLIT
```
    A pattern defining a ":" or ";".
  - VECTOR_SEP
```
public static final java.lang.String VECTOR_SEP
```
    Vector separator character - ":"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListParameter
```
public ListParameter(OptionID optionID,
                     T defaultValue)
```
    Constructs a list parameter with the given optionID.
    
    Parameters:
    
    optionID - the unique id of this parameter
    
    defaultValue - the default value of this parameter (may be null)
  - ListParameter
```
public ListParameter(OptionID optionID)
```
    Constructs a list parameter with the given optionID.
    
    Parameters:
    
    optionID - the unique id of this parameter
- Method Detail
  - size
```
public abstract int size()
```
    Size of the list.
    
    Returns:
    
    Size