Module com.io7m.jranges.core
Package com.io7m.jranges

Class RangeHalfOpenB

  • All Implemented Interfaces:
    RangeHalfOpenBType
    public final class RangeHalfOpenB
extends java.lang.Object
implements RangeHalfOpenBType
    A half open (inclusive lower, exclusive upper) range with BigInteger components.
    Since:
    4.0.0

    • Method Detail

      • lower

        public java.math.BigInteger lower()
        Specified by:
        lower in interface RangeHalfOpenBType
        Returns:
        The lower bound of the inclusive range.

      • upper

        public java.math.BigInteger upper()
        Specified by:
        upper in interface RangeHalfOpenBType
        Returns:
        The upper bound of the inclusive range.

      • withLower

        public final RangeHalfOpenB withLower​(java.math.BigInteger value)
        Copy the current immutable object by setting a value for the lower attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for lower
        Returns:
        A modified copy of the this object

      • withUpper

        public final RangeHalfOpenB withUpper​(java.math.BigInteger value)
        Copy the current immutable object by setting a value for the upper attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for upper
        Returns:
        A modified copy of the this object

      • equals

        public boolean equals​(java.lang.Object another)
        This instance is equal to all instances of RangeHalfOpenB that have equal attribute values.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if this is equal to another instance

      • hashCode

        public int hashCode()
        Computes a hash code from attributes: lower, upper.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        hashCode value

      • toString

        public java.lang.String toString()
        Prints the immutable value RangeHalfOpenB with attribute values.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the value

      • of

        public static RangeHalfOpenB of​(java.math.BigInteger lower,
                                java.math.BigInteger upper)
        Construct a new immutable RangeHalfOpenB instance.
        Parameters:
        lower - The value for the lower attribute
        upper - The value for the upper attribute
        Returns:
        An immutable RangeHalfOpenB instance

      • copyOf

        public static RangeHalfOpenB copyOf​(RangeHalfOpenBType instance)
        Creates an immutable copy of a RangeHalfOpenBType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
        Parameters:
        instance - The instance to copy
        Returns:
        A copied immutable RangeHalfOpenB instance

      • builder

        public static RangeHalfOpenB.Builder builder()
        Creates a builder for RangeHalfOpenB. 
         RangeHalfOpenB.builder()
    .setLower(java.math.BigInteger) // required lower
    .setUpper(java.math.BigInteger) // required upper
    .build();
        Returns:
        A new RangeHalfOpenB builder