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

Class ListParameterNoDuplicateValueConstraint<T>

java.lang.Object

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

All Implemented Interfaces:

ParameterConstraint<List<T>>

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

Parameter constraint specifying that a parameter list is not allowed to have duplicate values.

Author:

Arthur Zimek

Constructor Summary

Constructors

Constructor and Description
ListParameterNoDuplicateValueConstraint() Constructs a Not-Equal-Value parameter constraint.

Method Summary

Modifier and Type	Method and Description
String	getDescription(String parameterName) Returns a description of this constraint.
void	test(List<T> list) Checks if the elements of the list of parameter values do have different values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListParameterNoDuplicateValueConstraint

public ListParameterNoDuplicateValueConstraint()

Constructs a Not-Equal-Value parameter constraint. That is, the elements of a list of parameter values are not allowed to have equal values.

Method Detail

test

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

Checks if the elements of the list of parameter values do have different values. If not, a parameter exception is thrown.

Specified by:

test in interface ParameterConstraint<List<T>>

Parameters:

list - 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