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

Class LessEqualConstraint

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AbstractNumberConstraint<Number>

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

All Implemented Interfaces:

ParameterConstraint<Number>

public class LessEqualConstraint
extends AbstractNumberConstraint<Number>

Represents a Less-Equal-Than-Number parameter constraint. The value of the number parameter (NumberParameter) tested has to be less equal than the specified constraint value.

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AbstractNumberConstraint

constraintValue

Constructor Summary

Constructors

Constructor and Description
LessEqualConstraint(double constraintValue) Creates a Less-Equal-Than-Number parameter constraint.
LessEqualConstraint(int constraintValue) Creates a Less-Equal-Than-Number parameter constraint.
LessEqualConstraint(Number constraintValue) Creates a Less-Equal-Than-Number parameter constraint.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(String parameterName) Returns a description of this constraint.
void	test(Number t) Checks if the number value given by the number parameter is less equal than the constraint value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LessEqualConstraint

public LessEqualConstraint(Number constraintValue)

Creates a Less-Equal-Than-Number parameter constraint.

That is, the value of the appropriate number parameter has to be less equal than the given constraint value.

Parameters:

constraintValue - the constraint value

LessEqualConstraint

public LessEqualConstraint(double constraintValue)

Creates a Less-Equal-Than-Number parameter constraint.

That is, the value of the appropriate number parameter has to be less equal than the given constraint value.

Parameters:

constraintValue - the constraint value

LessEqualConstraint

public LessEqualConstraint(int constraintValue)

Creates a Less-Equal-Than-Number parameter constraint.

That is, the value of the appropriate number parameter has to be less equal than the given constraint value.

Parameters:

constraintValue - the constraint value

Method Detail

test

public void test(Number t)
          throws ParameterException

Checks if the number value given by the number parameter is less equal than the constraint value. If not, a parameter exception is thrown.

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.

Parameters:

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

Returns:

a description of this constraint