Package elki.utilities.optionhandling.constraints

Class GreaterConstraint

  • All Implemented Interfaces:
    ParameterConstraint<java.lang.Number>
    public class GreaterConstraint
extends AbstractNumberConstraint
    Represents a parameter constraint for testing if the value of the number parameter (NumberParameter) tested is greater than the specified constraint value.
    Since:
    0.1
    Author:
    Steffi Wanka

    • Constructor Summary

      Constructors 
      Constructor Description
      GreaterConstraint​(double constraintValue)
      Creates a Greater-Than-Number parameter constraint.
      GreaterConstraint​(int constraintValue)
      Creates a Greater-Than-Number parameter constraint.
      GreaterConstraint​(java.lang.Number constraintValue)
      Creates a Greater-Than-Number parameter constraint.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 than the constraint value.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GreaterConstraint

        public GreaterConstraint​(java.lang.Number constraintValue)
        Creates a Greater-Than-Number parameter constraint.

        That is, the value of the number parameter has to be greater than the given constraint value.

        Parameters:
        constraintValue - the constraint value

      • GreaterConstraint

        public GreaterConstraint​(int constraintValue)
        Creates a Greater-Than-Number parameter constraint.

        That is, the value of the number parameter has to be greater than the given constraint value.

        Parameters:
        constraintValue - the constraint value

      • GreaterConstraint

        public GreaterConstraint​(double constraintValue)
        Creates a Greater-Than-Number parameter constraint.

        That is, the value of the number parameter has to be greater than the given constraint value.

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