Class UnsignedInteger

    • Constructor Detail

      • UnsignedInteger

        public UnsignedInteger​(int underlying)
    • Method Detail

      • intValue

        public int intValue()
        Specified by:
        intValue in class java.lang.Number
      • longValue

        public long longValue()
        Specified by:
        longValue in class java.lang.Number
      • floatValue

        public float floatValue()
        Specified by:
        floatValue in class java.lang.Number
      • doubleValue

        public double doubleValue()
        Specified by:
        doubleValue in class java.lang.Number
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • compareTo

        public int compareTo​(int value)
        Compares the give integer value to this unsigned integer numerically treating the given value as unsigned.
        Parameters:
        value - the integer to compare to this unsigned integer instance.
        Returns:
        the value 0 if this == value; a value less than 0 if this < value as unsigned values; and a value greater than 0 if this > value as unsigned values
      • compareTo

        public int compareTo​(long value)
        Compares the give long value to this unsigned integer numerically treating the given value as unsigned.
        Parameters:
        value - the long to compare to this unsigned integer instance.
        Returns:
        the value 0 if this == value; a value less than 0 if this < value as unsigned values; and a value greater than 0 if this > value as unsigned values
      • compare

        public static int compare​(int left,
                                  int right)
        Compares two integer values numerically treating the values as unsigned.
        Parameters:
        left - the left hand side integer to compare
        right - the right hand side integer to compare
        Returns:
        the value 0 if left == right; a value less than 0 if left < right as unsigned values; and a value greater than 0 if left > right as unsigned values
      • compare

        public static int compare​(long left,
                                  long right)
        Compares two long values numerically treating the values as unsigned.
        Parameters:
        left - the left hand side long value to compare
        right - the right hand side long value to compare
        Returns:
        the value 0 if left == right; a value less than 0 if left < right as unsigned values; and a value greater than 0 if left > right as unsigned values
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

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

        public static UnsignedInteger valueOf​(int value)
        Returns an UnsignedInteger instance representing the specified int value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.
        Parameters:
        value - The int value to return as an UnsignedInteger instance.
        Returns:
        an UnsignedInteger instance representing the unsigned view of the given int.
      • valueOf

        public static UnsignedInteger valueOf​(java.lang.String value)
        Returns an UnsignedInteger instance representing the specified String value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.
        Parameters:
        value - The String value to return as an UnsignedInteger instance.
        Returns:
        an UnsignedInteger instance representing the unsigned view of the given String.
        Throws:
        java.lang.NumberFormatException - if the given value is greater than the max UnsignedInteger value possible or the String value given cannot be converted to a numeric value.
      • valueOf

        public static UnsignedInteger valueOf​(long value)
        Returns an UnsignedInteger instance representing the specified long value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.
        Parameters:
        value - The long value to return as an UnsignedInteger instance.
        Returns:
        an UnsignedInteger instance representing the unsigned view of the given long.
        Throws:
        java.lang.NumberFormatException - if the given value is greater than the max UnsignedInteger value possible.
      • toUnsignedLong

        public static long toUnsignedLong​(int value)
        Returns a long that represents the unsigned view of the given int value.
        Parameters:
        value - The integer whose unsigned value should be converted to a long.
        Returns:
        a positive long value that represents the given int as unsigned.