Class Limit

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class Limit
    extends java.lang.Object
    implements java.lang.Cloneable
    A limit consists of a value and information about whether the limit is strict or not.
    • Constructor Summary

      Constructors 
      Constructor Description
      Limit()
      Initialises an unbounded limit, i.e.
      Limit​(java.math.BigDecimal limit, boolean strict)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Limit add​(java.math.BigDecimal arg)
      Add the input value into the limit value
      java.lang.Object clone()  
      double getDoubleValue()
      Get the double limit value
      java.math.BigDecimal getValue()
      Get the limit value
      boolean isEqualTo​(java.math.BigDecimal arg)
      Is the input value equal to the limit value?
      boolean isLowerBoundOf​(Limit v)
      Is the input limit value lower bounded of the limit value?
      boolean isLowerBoundOf​(java.math.BigDecimal arg)
      Is the limit lower bound off the input value
      boolean isStrict()
      Is the limit strictly?
      boolean isStrictLowerBoundOf​(Limit v)
      Is the input limit value strictly lower bounded of the limit value?
      boolean isStrictLowerBoundOf​(java.math.BigDecimal arg)
      Is the limit strictly lower bound of the input value
      boolean isStrictUpperBoundOf​(Limit v)
      Is the input limit value strictly upper bounded of the limit value?
      boolean isStrictUpperBoundOf​(java.math.BigDecimal arg)
      Is the limit strictly upper bound of the input value
      boolean isUnbounded()
      Is not bounded?
      boolean isUpperBoundOf​(Limit v)
      Is the input limit value upper bounded of the limit value?
      boolean isUpperBoundOf​(java.math.BigDecimal arg)
      Is the limit upper bound off the input value
      void setStrict​(boolean strict)
      Set the strict value
      void setValue​(java.math.BigDecimal limit)
      Set the limit value
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Limit

        public Limit()
        Initialises an unbounded limit, i.e. the value is positive infinity.
      • Limit

        public Limit​(java.math.BigDecimal limit,
                     boolean strict)
        Constructor
        Parameters:
        limit - - The limit value
        strict - - Is strict?
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • isUnbounded

        public boolean isUnbounded()
        Is not bounded?
        Returns:
        - The limit value
      • getValue

        public java.math.BigDecimal getValue()
        Get the limit value
        Returns:
        value - The limit value
      • getDoubleValue

        public double getDoubleValue()
        Get the double limit value
        Returns:
        value - The double limit value
      • setValue

        public void setValue​(java.math.BigDecimal limit)
        Set the limit value
        Parameters:
        limit - - The limit value
      • isStrict

        public boolean isStrict()
        Is the limit strictly?
        Returns:
        strict - Is the limit strictly?
      • setStrict

        public void setStrict​(boolean strict)
        Set the strict value
        Parameters:
        strict - - The value
      • isUpperBoundOf

        public boolean isUpperBoundOf​(java.math.BigDecimal arg)
        Is the limit upper bound off the input value
        Parameters:
        arg - - The bound value
        Returns:
        Is the limit upper bounded?
      • isLowerBoundOf

        public boolean isLowerBoundOf​(java.math.BigDecimal arg)
        Is the limit lower bound off the input value
        Parameters:
        arg - - The bound value
        Returns:
        Is the limit lower bound?
      • isStrictUpperBoundOf

        public boolean isStrictUpperBoundOf​(java.math.BigDecimal arg)
        Is the limit strictly upper bound of the input value
        Parameters:
        arg - - The bound value
        Returns:
        Is the limit strictly upper bound?
      • isStrictLowerBoundOf

        public boolean isStrictLowerBoundOf​(java.math.BigDecimal arg)
        Is the limit strictly lower bound of the input value
        Parameters:
        arg - - The input value
        Returns:
        Is the limit strictly lower bound?
      • add

        public Limit add​(java.math.BigDecimal arg)
        Add the input value into the limit value
        Parameters:
        arg - - The input value
        Returns:
        The new limit value
      • isEqualTo

        public boolean isEqualTo​(java.math.BigDecimal arg)
        Is the input value equal to the limit value?
        Parameters:
        arg - - The input value
        Returns:
        Is the input value lower and upper bounded of the lime value?
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException
      • isLowerBoundOf

        public boolean isLowerBoundOf​(Limit v)
        Is the input limit value lower bounded of the limit value?
        Parameters:
        v - - The limit value
        Returns:
        Is the input value lower bounded of the lime value?
      • isUpperBoundOf

        public boolean isUpperBoundOf​(Limit v)
        Is the input limit value upper bounded of the limit value?
        Parameters:
        v - - The input limit value
        Returns:
        Is the input value upper bounded of the lime value?
      • isStrictLowerBoundOf

        public boolean isStrictLowerBoundOf​(Limit v)
        Is the input limit value strictly lower bounded of the limit value?
        Parameters:
        v - - The input limit value
        Returns:
        Is the input limit value strictly lower bounded of the limit value?
      • isStrictUpperBoundOf

        public boolean isStrictUpperBoundOf​(Limit v)
        Is the input limit value strictly upper bounded of the limit value?
        Parameters:
        v - - The input limit value
        Returns:
        whether the upper bound is strict