SignednessUtil (checker-framework 3.11.0 API)

java.lang.Object
- org.checkerframework.checker.signedness.util.SignednessUtil

```
@AnnotatedFor(value="nullness")
public final class SignednessUtil
extends Object
```
Provides static utility methods for unsigned values, beyond what is available in the JDK's Unsigned Integer API. The JDK's Unsigned Integer API is methods in primitive wrapper classes and in classes Arrays, RandomAccessFile, ObjectInputStream, and DataInputStream.
SignednessUtilExtra has more methods that reference packages that Android does not provide. That is, SignednessUtil can be used anywhere, and SignednessUtilExtra can be used anywhere except on Android.

See the Checker Framework Manual:
Utility routines for manipulating unsigned values

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static @Unsigned byte`	`byteFromDouble(double d)` Returns an unsigned byte representing the same value as the double.
`static @Unsigned byte`	`byteFromFloat(float f)` Returns an unsigned byte representing the same value as the float.
`static int`	`compareUnsigned(@Unsigned byte x, @Unsigned byte y)` Compares two unsigned bytes x and y.
`static int`	`compareUnsigned(@Unsigned short x, @Unsigned short y)` Compares two unsigned shorts x and y.
`static @Unsigned byte`	`getUnsigned(ByteBuffer b)` Gets an unsigned byte from the ByteBuffer b.
`static void`	`getUnsigned(ByteBuffer b, @Unsigned byte[] bs)` Gets an array of unsigned bytes from the ByteBuffer b and stores them in the array bs.
`static ByteBuffer`	`getUnsigned(ByteBuffer b, byte[] bs, int i, int l)` Populates an unsigned byte array from the ByteBuffer b at i with l bytes.
`static @Unsigned byte`	`getUnsigned(ByteBuffer b, int i)` Gets an unsigned byte from the ByteBuffer b at i.
`static @Unsigned int`	`getUnsigned(IntBuffer b, int i)` Gets an unsigned int from the IntBuffer b at i.
`static @Unsigned int`	`getUnsignedInt(ByteBuffer b)` Gets an unsigned int from the ByteBuffer b.
`static @Unsigned short`	`getUnsignedShort(ByteBuffer b)` Gets an unsigned short from the ByteBuffer b.
`static @Unsigned int`	`intFromDouble(double d)` Returns an unsigned int representing the same value as the double.
`static @Unsigned int`	`intFromFloat(float f)` Returns an unsigned int representing the same value as the float.
`static @Unsigned long`	`longFromDouble(double d)` Returns an unsigned long representing the same value as the double.
`static @Unsigned long`	`longFromFloat(float f)` Returns an unsigned long representing the same value as the float.
`static ByteBuffer`	`putUnsigned(ByteBuffer b, @Unsigned byte ubyte)` Places an unsigned byte into the ByteBuffer b.
`static ByteBuffer`	`putUnsigned(ByteBuffer b, int i, @Unsigned byte ubyte)` Places an unsigned byte into the ByteBuffer b at i.
`static IntBuffer`	`putUnsigned(IntBuffer b, @Unsigned int uint)` Places an unsigned int into the IntBuffer b.
`static IntBuffer`	`putUnsigned(IntBuffer b, @Unsigned int[] uints)` Places an unsigned int array into the IntBuffer b.
`static IntBuffer`	`putUnsigned(IntBuffer b, @Unsigned int[] uints, int i, int l)` Places an unsigned int array into the IntBuffer b at i with length l.
`static IntBuffer`	`putUnsigned(IntBuffer b, int i, @Unsigned int uint)` Places an unsigned int into the IntBuffer b at i.
`static ByteBuffer`	`putUnsignedInt(ByteBuffer b, @Unsigned int uint)` Places an unsigned int into the ByteBuffer b.
`static ByteBuffer`	`putUnsignedInt(ByteBuffer b, int i, @Unsigned int uint)` Places an unsigned int into the ByteBuffer b at i.
`static ByteBuffer`	`putUnsignedLong(ByteBuffer b, int i, @Unsigned long ulong)` Places an unsigned long into the ByteBuffer b at i.
`static ByteBuffer`	`putUnsignedShort(ByteBuffer b, int i, @Unsigned short ushort)` Places an unsigned short into the ByteBuffer b at i.
`static ByteBuffer`	`putUnsignedShort(ByteBuffer b, @Unsigned short ushort)` Places an unsigned short into the ByteBuffer b.
`static void`	`readFullyUnsigned(RandomAccessFile f, @Unsigned byte[] b)` Reads a file fully into an unsigned byte array.
`static int`	`readUnsigned(RandomAccessFile f, @Unsigned byte[] b, int off, int len)` Reads up to `len` bytes of data from this file into an unsigned array of bytes.
`static @Unsigned char`	`readUnsignedChar(RandomAccessFile f)` Reads an unsigned char from the RandomAccessFile f.
`static @Unsigned int`	`readUnsignedInt(RandomAccessFile f)` Reads an unsigned int from the RandomAccessFile f.
`static @Unsigned long`	`readUnsignedLong(RandomAccessFile f)` Reads an unsigned long from the RandomAccessFile f.
`static @Unsigned short`	`shortFromDouble(double d)` Returns an unsigned short representing the same value as the double.
`static @Unsigned short`	`shortFromFloat(float f)` Returns an unsigned short representing the same value as the float.
`static double`	`toDouble(@Unsigned byte b)` Returns a double representing the same value as the unsigned byte.
`static double`	`toDouble(@Unsigned int i)` Returns a double representing the same value as the unsigned int.
`static double`	`toDouble(@Unsigned long l)` Returns a double representing the same value as the unsigned long.
`static double`	`toDouble(@Unsigned short s)` Returns a double representing the same value as the unsigned short.
`static float`	`toFloat(@Unsigned byte b)` Returns a float representing the same value as the unsigned byte.
`static float`	`toFloat(@Unsigned int i)` Returns a float representing the same value as the unsigned int.
`static float`	`toFloat(@Unsigned long l)` Returns a float representing the same value as the unsigned long.
`static float`	`toFloat(@Unsigned short s)` Returns a float representing the same value as the unsigned short.
`static @Unsigned int`	`toUnsignedInt(@Unsigned char c)` Returns an unsigned int representing the same value as an unsigned char.
`static @Unsigned long`	`toUnsignedLong(@Unsigned char c)` Returns an unsigned long representing the same value as an unsigned char.
`static @Unsigned short`	`toUnsignedShort(@Unsigned byte b)` Returns an unsigned short representing the same value as an unsigned byte.
`static @Unsigned short`	`toUnsignedShort(@Unsigned char c)` Returns an unsigned short representing the same value as an unsigned char.
`static String`	`toUnsignedString(@Unsigned byte b)` Produces a string representation of the unsigned byte b.
`static String`	`toUnsignedString(@Unsigned byte b, int radix)` Produces a string representation of the unsigned byte b in base radix.
`static String`	`toUnsignedString(@Unsigned short s)` Produces a string representation of the unsigned short s.
`static String`	`toUnsignedString(@Unsigned short s, int radix)` Produces a string representation of the unsigned short s in base radix.
`static ByteBuffer`	`wrapUnsigned(@Unsigned byte[] array)` Wraps an unsigned byte array into a ByteBuffer.
`static ByteBuffer`	`wrapUnsigned(@Unsigned byte[] array, int offset, int length)` Wraps an unsigned byte array into a ByteBuffer.
`static void`	`writeUnsigned(RandomAccessFile f, @Unsigned byte[] bs, int off, int len)` Writes len unsigned bytes to the RandomAccessFile f at offset off.
`static void`	`writeUnsignedByte(RandomAccessFile f, @Unsigned byte b)` Writes an unsigned byte to the RandomAccessFile f.
`static void`	`writeUnsignedChar(RandomAccessFile f, @Unsigned char c)` Writes an unsigned char to the RandomAccessFile f.
`static void`	`writeUnsignedInt(RandomAccessFile f, @Unsigned int i)` Writes an unsigned byte to the RandomAccessFile f.
`static void`	`writeUnsignedLong(RandomAccessFile f, @Unsigned long l)` Writes an unsigned byte to the RandomAccessFile f.
`static void`	`writeUnsignedShort(RandomAccessFile f, @Unsigned short s)` Writes an unsigned short to the RandomAccessFile f.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - wrapUnsigned
```
public static ByteBuffer wrapUnsigned(@Unsigned byte[] array)
```
    Wraps an unsigned byte array into a ByteBuffer. This method is a wrapper around wrap(byte[]), but assumes that the input should be interpreted as unsigned.
  - wrapUnsigned
```
public static ByteBuffer wrapUnsigned(@Unsigned byte[] array,
                                      int offset,
                                      int length)
```
    Wraps an unsigned byte array into a ByteBuffer. This method is a wrapper around wrap(byte[], int, int), but assumes that the input should be interpreted as unsigned.
  - getUnsignedInt
```
public static @Unsigned int getUnsignedInt(ByteBuffer b)
```
    Gets an unsigned int from the ByteBuffer b. This method is a wrapper around getInt(), but assumes that the result should be interpreted as unsigned.
  - getUnsignedShort
```
public static @Unsigned short getUnsignedShort(ByteBuffer b)
```
    Gets an unsigned short from the ByteBuffer b. This method is a wrapper around getShort(), but assumes that the result should be interpreted as unsigned.
  - getUnsigned
```
public static @Unsigned byte getUnsigned(ByteBuffer b)
```
    Gets an unsigned byte from the ByteBuffer b. This method is a wrapper around get(), but assumes that the result should be interpreted as unsigned.
  - getUnsigned
```
public static @Unsigned byte getUnsigned(ByteBuffer b,
                                         int i)
```
    Gets an unsigned byte from the ByteBuffer b at i. This method is a wrapper around get(int), but assumes that the result should be interpreted as unsigned.
  - getUnsigned
```
public static ByteBuffer getUnsigned(ByteBuffer b,
                                     byte[] bs,
                                     int i,
                                     int l)
```
    Populates an unsigned byte array from the ByteBuffer b at i with l bytes. This method is a wrapper around get(byte[], int, int), but assumes that the bytes should be interpreted as unsigned.
  - putUnsigned
```
public static ByteBuffer putUnsigned(ByteBuffer b,
                                     @Unsigned byte ubyte)
```
    Places an unsigned byte into the ByteBuffer b. This method is a wrapper around put(byte), but assumes that the input should be interpreted as unsigned.
  - putUnsigned
```
public static ByteBuffer putUnsigned(ByteBuffer b,
                                     int i,
                                     @Unsigned byte ubyte)
```
    Places an unsigned byte into the ByteBuffer b at i. This method is a wrapper around put(int, byte), but assumes that the input should be interpreted as unsigned.
  - putUnsigned
```
public static IntBuffer putUnsigned(IntBuffer b,
                                    @Unsigned int uint)
```
    Places an unsigned int into the IntBuffer b. This method is a wrapper around put(int), but assumes that the input should be interpreted as unsigned.
  - putUnsigned
```
public static IntBuffer putUnsigned(IntBuffer b,
                                    int i,
                                    @Unsigned int uint)
```
    Places an unsigned int into the IntBuffer b at i. This method is a wrapper around put(int, int), but assumes that the input should be interpreted as unsigned.
  - putUnsigned
```
public static IntBuffer putUnsigned(IntBuffer b,
                                    @Unsigned int[] uints)
```
    Places an unsigned int array into the IntBuffer b. This method is a wrapper around put(int[]), but assumes that the input should be interpreted as unsigned.
  - putUnsigned
```
public static IntBuffer putUnsigned(IntBuffer b,
                                    @Unsigned int[] uints,
                                    int i,
                                    int l)
```
    Places an unsigned int array into the IntBuffer b at i with length l. This method is a wrapper around put(int[], int, int), but assumes that the input should be interpreted as unsigned.
  - getUnsigned
```
public static @Unsigned int getUnsigned(IntBuffer b,
                                        int i)
```
    Gets an unsigned int from the IntBuffer b at i. This method is a wrapper around get(int), but assumes that the output should be interpreted as unsigned.
  - putUnsignedShort
```
public static ByteBuffer putUnsignedShort(ByteBuffer b,
                                          @Unsigned short ushort)
```
    Places an unsigned short into the ByteBuffer b. This method is a wrapper around putShort(short), but assumes that the input should be interpreted as unsigned.
  - putUnsignedShort
```
public static ByteBuffer putUnsignedShort(ByteBuffer b,
                                          int i,
                                          @Unsigned short ushort)
```
    Places an unsigned short into the ByteBuffer b at i. This method is a wrapper around putShort(int, short), but assumes that the input should be interpreted as unsigned.
  - putUnsignedInt
```
public static ByteBuffer putUnsignedInt(ByteBuffer b,
                                        @Unsigned int uint)
```
    Places an unsigned int into the ByteBuffer b. This method is a wrapper around putInt(int), but assumes that the input should be interpreted as unsigned.
  - putUnsignedInt
```
public static ByteBuffer putUnsignedInt(ByteBuffer b,
                                        int i,
                                        @Unsigned int uint)
```
    Places an unsigned int into the ByteBuffer b at i. This method is a wrapper around putInt(int, int), but assumes that the input should be interpreted as unsigned.
  - putUnsignedLong
```
public static ByteBuffer putUnsignedLong(ByteBuffer b,
                                         int i,
                                         @Unsigned long ulong)
```
    Places an unsigned long into the ByteBuffer b at i. This method is a wrapper around putLong(int, long), but assumes that the input should be interpreted as unsigned.
  - readUnsignedChar
```
public static @Unsigned char readUnsignedChar(RandomAccessFile f)
                                       throws IOException
```
    Reads an unsigned char from the RandomAccessFile f. This method is a wrapper around readChar(), but assumes the output should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - readUnsignedInt
```
public static @Unsigned int readUnsignedInt(RandomAccessFile f)
                                     throws IOException
```
    Reads an unsigned int from the RandomAccessFile f. This method is a wrapper around readInt(), but assumes the output should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - readUnsignedLong
```
public static @Unsigned long readUnsignedLong(RandomAccessFile f)
                                       throws IOException
```
    Reads an unsigned long from the RandomAccessFile f. This method is a wrapper around readLong(), but assumes the output should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - readUnsigned
```
public static int readUnsigned(RandomAccessFile f,
                               @Unsigned byte[] b,
                               int off,
                               int len)
                        throws IOException
```
    Reads up to len bytes of data from this file into an unsigned array of bytes. This method is a wrapper around read(byte[], int, int), but assumes the output should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - readFullyUnsigned
```
public static void readFullyUnsigned(RandomAccessFile f,
                                     @Unsigned byte[] b)
                              throws IOException
```
    Reads a file fully into an unsigned byte array. This method is a wrapper around readFully(byte[]), but assumes the output should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsigned
```
public static void writeUnsigned(RandomAccessFile f,
                                 @Unsigned byte[] bs,
                                 int off,
                                 int len)
                          throws IOException
```
    Writes len unsigned bytes to the RandomAccessFile f at offset off. This method is a wrapper around write(byte[], int, int), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsignedByte
```
public static void writeUnsignedByte(RandomAccessFile f,
                                     @Unsigned byte b)
                              throws IOException
```
    Writes an unsigned byte to the RandomAccessFile f. This method is a wrapper around writeByte(int), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsignedChar
```
public static void writeUnsignedChar(RandomAccessFile f,
                                     @Unsigned char c)
                              throws IOException
```
    Writes an unsigned char to the RandomAccessFile f. This method is a wrapper around writeChar(int), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsignedShort
```
public static void writeUnsignedShort(RandomAccessFile f,
                                      @Unsigned short s)
                               throws IOException
```
    Writes an unsigned short to the RandomAccessFile f. This method is a wrapper around writeShort(int), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsignedInt
```
public static void writeUnsignedInt(RandomAccessFile f,
                                    @Unsigned int i)
                             throws IOException
```
    Writes an unsigned byte to the RandomAccessFile f. This method is a wrapper around writeInt(int), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - writeUnsignedLong
```
public static void writeUnsignedLong(RandomAccessFile f,
                                     @Unsigned long l)
                              throws IOException
```
    Writes an unsigned byte to the RandomAccessFile f. This method is a wrapper around writeLong(long), but assumes the input should be interpreted as unsigned.
    
    Throws:
    
    IOException
  - getUnsigned
```
public static void getUnsigned(ByteBuffer b,
                               @Unsigned byte[] bs)
```
    Gets an array of unsigned bytes from the ByteBuffer b and stores them in the array bs. This method is a wrapper around get(byte[]), but assumes that the array of bytes should be interpreted as unsigned.
  - compareUnsigned
```
public static int compareUnsigned(@Unsigned short x,
                                  @Unsigned short y)
```
    Compares two unsigned shorts x and y.
    In Java 11 or later, use Short.compareUnsigned.
    
    Parameters:
    
    x - the first value to compare
    
    y - the second value to compare
    
    Returns:
    
    a negative number iff x < y, a positive number iff x > y, and zero iff x == y.
  - compareUnsigned
```
public static int compareUnsigned(@Unsigned byte x,
                                  @Unsigned byte y)
```
    Compares two unsigned bytes x and y.
    In Java 11 or later, use Byte.compareUnsigned.
    
    Parameters:
    
    x - the first value to compare
    
    y - the second value to compare
    
    Returns:
    
    a negative number iff x < y, a positive number iff x > y, and zero iff x == y.
  - toUnsignedString
```
public static String toUnsignedString(@Unsigned short s)
```
    Produces a string representation of the unsigned short s.
  - toUnsignedString
```
public static String toUnsignedString(@Unsigned short s,
                                      int radix)
```
    Produces a string representation of the unsigned short s in base radix.
  - toUnsignedString
```
public static String toUnsignedString(@Unsigned byte b)
```
    Produces a string representation of the unsigned byte b.
  - toUnsignedString
```
public static String toUnsignedString(@Unsigned byte b,
                                      int radix)
```
    Produces a string representation of the unsigned byte b in base radix.
  - toUnsignedShort
```
public static @Unsigned short toUnsignedShort(@Unsigned byte b)
```
    Returns an unsigned short representing the same value as an unsigned byte.
  - toUnsignedLong
```
public static @Unsigned long toUnsignedLong(@Unsigned char c)
```
    Returns an unsigned long representing the same value as an unsigned char.
  - toUnsignedInt
```
public static @Unsigned int toUnsignedInt(@Unsigned char c)
```
    Returns an unsigned int representing the same value as an unsigned char.
  - toUnsignedShort
```
public static @Unsigned short toUnsignedShort(@Unsigned char c)
```
    Returns an unsigned short representing the same value as an unsigned char.
  - toFloat
```
public static float toFloat(@Unsigned byte b)
```
    Returns a float representing the same value as the unsigned byte.
  - toFloat
```
public static float toFloat(@Unsigned short s)
```
    Returns a float representing the same value as the unsigned short.
  - toFloat
```
public static float toFloat(@Unsigned int i)
```
    Returns a float representing the same value as the unsigned int.
  - toFloat
```
public static float toFloat(@Unsigned long l)
```
    Returns a float representing the same value as the unsigned long.
  - toDouble
```
public static double toDouble(@Unsigned byte b)
```
    Returns a double representing the same value as the unsigned byte.
  - toDouble
```
public static double toDouble(@Unsigned short s)
```
    Returns a double representing the same value as the unsigned short.
  - toDouble
```
public static double toDouble(@Unsigned int i)
```
    Returns a double representing the same value as the unsigned int.
  - toDouble
```
public static double toDouble(@Unsigned long l)
```
    Returns a double representing the same value as the unsigned long.
  - byteFromFloat
```
public static @Unsigned byte byteFromFloat(float f)
```
    Returns an unsigned byte representing the same value as the float.
  - shortFromFloat
```
public static @Unsigned short shortFromFloat(float f)
```
    Returns an unsigned short representing the same value as the float.
  - intFromFloat
```
public static @Unsigned int intFromFloat(float f)
```
    Returns an unsigned int representing the same value as the float.
  - longFromFloat
```
public static @Unsigned long longFromFloat(float f)
```
    Returns an unsigned long representing the same value as the float.
  - byteFromDouble
```
public static @Unsigned byte byteFromDouble(double d)
```
    Returns an unsigned byte representing the same value as the double.
  - shortFromDouble
```
public static @Unsigned short shortFromDouble(double d)
```
    Returns an unsigned short representing the same value as the double.
  - intFromDouble
```
public static @Unsigned int intFromDouble(double d)
```
    Returns an unsigned int representing the same value as the double.
  - longFromDouble
```
public static @Unsigned long longFromDouble(double d)
```
    Returns an unsigned long representing the same value as the double.

Class SignednessUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

wrapUnsigned

wrapUnsigned

getUnsignedInt

getUnsignedShort

getUnsigned

getUnsigned

getUnsigned

putUnsigned

putUnsigned

putUnsigned

putUnsigned

putUnsigned

putUnsigned

getUnsigned

putUnsignedShort

putUnsignedShort

putUnsignedInt

putUnsignedInt

putUnsignedLong

readUnsignedChar

readUnsignedInt

readUnsignedLong

readUnsigned

readFullyUnsigned

writeUnsigned

writeUnsignedByte

writeUnsignedChar

writeUnsignedShort

writeUnsignedInt

writeUnsignedLong

getUnsigned

compareUnsigned

compareUnsigned

toUnsignedString

toUnsignedString

toUnsignedString

toUnsignedString

toUnsignedShort

toUnsignedLong

toUnsignedInt

toUnsignedShort

toFloat

toFloat

toFloat

toFloat

toDouble

toDouble

toDouble

toDouble

byteFromFloat

shortFromFloat

intFromFloat

longFromFloat

byteFromDouble

shortFromDouble

intFromDouble

longFromDouble