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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AbstractNumberConstraint<Number>
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.GreaterEqualConstraint
All Implemented Interfaces:
ParameterConstraint<Number>

public class GreaterEqualConstraint
extends AbstractNumberConstraint<Number>

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.


Field Summary
 
Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.AbstractNumberConstraint
constraintValue
 
Constructor Summary
GreaterEqualConstraint(Number constraintValue)
          Creates a Greater-Equal parameter constraint.
 
Method Summary
 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 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(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
Method Detail

test

public void test(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 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

Release 0.4.0 (2011-09-20_1324)