de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints

Class ListEachConstraint<T>

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ListEachConstraint<T>

All Implemented Interfaces:

ParameterConstraint<List<T>>

public class ListEachConstraint<T>
extends Object
implements ParameterConstraint<List<T>>

Applies constraints to all elements of a list.

Field Summary

Fields

Modifier and Type	Field and Description
private List<ParameterConstraint<? super T>>	constraints Constraints

Constructor Summary

Constructors

Constructor and Description
ListEachConstraint() Constructor.
ListEachConstraint(ParameterConstraint<? super T> constraint) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConstraint(ParameterConstraint<? super T> constraint) Add a constraint to this operator.
String	getDescription(String parameterName) Returns a description of this constraint.
void	test(List<T> t) Checks if the value t of the parameter to be tested fulfills the parameter constraint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

constraints

private List<ParameterConstraint<? super T>> constraints

Constraints

Constructor Detail

ListEachConstraint

public ListEachConstraint()

Constructor.

ListEachConstraint

public ListEachConstraint(ParameterConstraint<? super T> constraint)

Constructor.

Parameters:

constraint - Constraint to apply to all elements

Method Detail

addConstraint

public void addConstraint(ParameterConstraint<? super T> constraint)

Add a constraint to this operator.

Parameters:

constraint - Constraint

test

public void test(List<T> t)
          throws ParameterException

Description copied from interface: ParameterConstraint

Checks if the value t of the parameter to be tested fulfills the parameter constraint. If not, a parameter exception is thrown.

Specified by:

test in interface ParameterConstraint<List<T>>

Parameters:

t - Value to be checked whether or not it fulfills the underlying parameter constraint.

Throws:

ParameterException - if the parameter to be tested does not fulfill the parameter constraint

getDescription

public String getDescription(String parameterName)

Description copied from interface: ParameterConstraint

Returns a description of this constraint.

Specified by:

getDescription in interface ParameterConstraint<List<T>>

Parameters:

parameterName - the name of the parameter this constraint is used for

Returns:

a description of this constraint