Top Description Fields Constructors Methods
com.sun.jna

public abstract Class IntegerType

extends Number
implements NativeMapped
Class Inheritance
All Implemented Interfaces
com.sun.jna.NativeMapped
Known Direct Subclasses
com.sun.jna.NativeLong, com.sun.jna.Structure.FFIType.size_t
Imports
java.lang.reflect.InvocationTargetException
Represents a native integer value, which may have a platform-specific size (e.g. long on unix-based platforms). May optionally indicate an unsigned attribute, such that when a value is extracted into a larger-sized container (e.g. int retrieved via Number#longValue, the value will be unsigned. Default behavior is signed.
Authors
[email protected], [email protected]

Field Summary

Modifier and TypeField and Description
private Number
number

private static final long
serialVersionUID

Hides java.lang.Number.serialVersionUID.

private int
size

private boolean
unsigned

private long
value

Constructor Summary

AccessConstructor and Description
public
IntegerType(int size)

Create a zero-valued signed IntegerType.

public
IntegerType(int size, boolean unsigned)

Create a zero-valued optionally unsigned IntegerType.

public
IntegerType(int size, long value)

Create a signed IntegerType with the given value.

public
IntegerType(int size, long value, boolean unsigned)

Create an optionally signed IntegerType with the given value.

Method Summary

Modifier and TypeMethod and Description
public static <
the derived integer type
T extends IntegerType> int

Returns:

0 if values are equal - including if both are null, negative if 1st value less than 2nd one, positive otherwise

Note

the comparison uses the longValue().

compare(T
The 1st value
v1, T
The 2nd value
v2)

Compares 2 derived IntegerType values - Note: a null value is considered greater than any non-null one (i.e., null values are "pushed" to the end of a sorted array / list of values)

public static int

Returns:

0 if values are equal, negative if 1st value less than 2nd one, positive otherwise

Note

the comparison uses the longValue().

compare(IntegerType
The IntegerType value
v1, long
The long value
v2)

Compares a IntegerType value with a long one

Note

if the IntegerType value is null then it is consider greater than any long value.

public static final int
compare(long v1, long v2)

public double
doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of the specified number as a double.
public boolean
equals(Object
the reference object with which to compare.
rhs)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public float
floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of the specified number as a float.
public Object
fromNative(Object
Java representation of the native type to be converted.
nativeValue, FromNativeContext
Context in which the conversion is taking place.
context)

Implements com.sun.jna.NativeMapped.fromNative.

Convert the given native object into its Java representation using the given context.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public int
intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of the specified number as an int.
public long
longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of the specified number as a long.
public Class<?>
nativeType()

Implements com.sun.jna.NativeMapped.nativeType.

Indicate the native type used by this converter.
public void
setValue(long
value to set
value)

Change the value for this data.

public Object
toNative()

Implements com.sun.jna.NativeMapped.toNative.

Convert this object into a supported native type.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Number:
byteValueshortValue

Field Detail

numberback to summary
private Number number
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

sizeback to summary
private int size
unsignedback to summary
private boolean unsigned
valueback to summary
private long value

Constructor Detail

IntegerTypeback to summary
public IntegerType(int size)

Create a zero-valued signed IntegerType.

IntegerTypeback to summary
public IntegerType(int size, boolean unsigned)

Create a zero-valued optionally unsigned IntegerType.

IntegerTypeback to summary
public IntegerType(int size, long value)

Create a signed IntegerType with the given value.

IntegerTypeback to summary
public IntegerType(int size, long value, boolean unsigned)

Create an optionally signed IntegerType with the given value.

Method Detail

compareback to summary
public static <T extends IntegerType> int compare(T v1, T v2)

Compares 2 derived IntegerType values - Note: a null value is considered greater than any non-null one (i.e., null values are "pushed" to the end of a sorted array / list of values)

Parameters
<T>
the derived integer type
v1:T

The 1st value

v2:T

The 2nd value

Returns:int

0 if values are equal - including if both are null, negative if 1st value less than 2nd one, positive otherwise

Note

the comparison uses the longValue().

See Also
compare(long, long)
compareback to summary
public static int compare(IntegerType v1, long v2)

Compares a IntegerType value with a long one

Note

if the IntegerType value is null then it is consider greater than any long value.

Parameters
v1:IntegerType

The IntegerType value

v2:long

The long value

Returns:int

0 if values are equal, negative if 1st value less than 2nd one, positive otherwise

Note

the comparison uses the longValue().

See Also
compare(long, long)
compareback to summary
public static final int compare(long v1, long v2)
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Doc from java.lang.Number.doubleValue.

Returns the value of the specified number as a double.

Returns:double

the numeric value represented by this object after conversion to type double.

Annotations
@Override
equalsback to summary
public boolean equals(Object rhs)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
rhs:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

Doc from java.lang.Number.floatValue.

Returns the value of the specified number as a float.

Returns:float

the numeric value represented by this object after conversion to type float.

Annotations
@Override
fromNativeback to summary
public Object fromNative(Object nativeValue, FromNativeContext context)

Implements com.sun.jna.NativeMapped.fromNative.

Doc from com.sun.jna.NativeMapped.fromNative.

Convert the given native object into its Java representation using the given context.

Parameters
nativeValue:Object

Java representation of the native type to be converted.

context:FromNativeContext

Context in which the conversion is taking place.

Returns:Object

Converted object.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

Doc from java.lang.Number.intValue.

Returns the value of the specified number as an int.

Returns:int

the numeric value represented by this object after conversion to type int.

Annotations
@Override
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

Doc from java.lang.Number.longValue.

Returns the value of the specified number as a long.

Returns:long

the numeric value represented by this object after conversion to type long.

Annotations
@Override
nativeTypeback to summary
public Class<?> nativeType()

Implements com.sun.jna.NativeMapped.nativeType.

Doc from com.sun.jna.NativeMapped.nativeType.

Indicate the native type used by this converter.

Returns:Class<?>

Java class representation of the native type.

Annotations
@Override
setValueback to summary
public void setValue(long value)

Change the value for this data.

Parameters
value:long

value to set

toNativeback to summary
public Object toNative()

Implements com.sun.jna.NativeMapped.toNative.

Doc from com.sun.jna.NativeMapped.toNative.

Convert this object into a supported native type.

Returns:Object

Java representation of the original Java object converted to a native type.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override