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

Class ListSizeConstraint

java.lang.Object

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

All Implemented Interfaces:

ParameterConstraint<List<?>>

public class ListSizeConstraint
extends Object
implements ParameterConstraint<List<?>>

Represents a list-size parameter constraint. The size of the list parameter ( ListParameter) to be tested has to be equal to the specified list size constraint.

Field Summary

Fields

Modifier and Type	Field and Description
private int	sizeConstraint The list size constraint.

Constructor Summary

Constructors

Constructor and Description
ListSizeConstraint(int size) Constructs a list size constraint with the given constraint size.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(String parameterName) Returns a description of this constraint.
void	test(List<?> t) Checks if the list parameter fulfills the size constraint.

Methods inherited from class java.lang.Object

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

Field Detail

sizeConstraint

private int sizeConstraint

The list size constraint.

Constructor Detail

ListSizeConstraint

public ListSizeConstraint(int size)

Constructs a list size constraint with the given constraint size.

Parameters:

size - the size constraint for the list parameter

Method Detail

test

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

Checks if the list parameter fulfills the size constraint. If not, a parameter exception is thrown.

Specified by:

test in interface ParameterConstraint<List<?>>

Parameters:

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

Throws:

ParameterException, - if the size of the list parameter given is not equal to the list size constraint specified.

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

Parameters:

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

Returns:

a description of this constraint