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

Class GreaterEqualConstraint

java.lang.Object

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

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

All Implemented Interfaces:

ParameterConstraint<java.lang.Number>

public class GreaterEqualConstraint
extends AbstractNumberConstraint

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

Since:

0.1

Author:

Steffi Wanka

Field Summary

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

constraintValue

Constructor Summary

Constructors

Constructor and Description
GreaterEqualConstraint(double constraintValue) Creates a Greater-Equal parameter constraint.
GreaterEqualConstraint(int constraintValue) Creates a Greater-Equal parameter constraint.
GreaterEqualConstraint(java.lang.Number constraintValue) Creates a Greater-Equal parameter constraint.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(java.lang.String parameterName) Returns a description of this constraint.
void	test(java.lang.Number t) Checks if the number value given by the number parameter is greater 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

GreaterEqualConstraint

public GreaterEqualConstraint(java.lang.Number constraintValue)

Creates a Greater-Equal parameter constraint. That is, the value of the number parameter given has to be greater equal than the constraint value given.

Parameters:

constraintValue - the constraint value

GreaterEqualConstraint

public GreaterEqualConstraint(int constraintValue)

Creates a Greater-Equal parameter constraint. That is, the value of the number parameter given has to be greater equal than the constraint value given.

Parameters:

constraintValue - the constraint value

GreaterEqualConstraint

public GreaterEqualConstraint(double constraintValue)

Creates a Greater-Equal parameter constraint. That is, the value of the number parameter given has to be greater equal than the constraint value given.

Parameters:

constraintValue - the constraint value

Method Detail

test

public void test(java.lang.Number t)
          throws ParameterException

Checks if the number value given by the number parameter is greater 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 java.lang.String getDescription(java.lang.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