Top Description Fields Constructors Methods
com.kenai.jffi

public final Class Array

extends Aggregate
Class Inheritance

Describes the layout of a C array

Field Summary

Modifier and TypeField and Description
private final Type
private final int

Constructor Summary

AccessConstructor and Description
public
Array(Type
The type of fields contained in the struct.
elementType
,
int
the number of elements.
length
)

Creates a new C array layout description.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides com.kenai.jffi.Type.equals.

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

Returns:

The Type of the elements in the array
getElementType
()

Returns the type of elements in the array

public int
hashCode()

Overrides com.kenai.jffi.Type.hashCode.

Returns a hash code value for the object.
public final int

Returns:

The number of elements in the array
length
()

Returns the number of elements in the array

public static Array
newArray(Type
The type of each element of the array
elementType
,
int
The length of the array.
length
)

Creates a new C array layout description.

Inherited from com.kenai.jffi.Aggregate:
disposefinalizegetTypeInfo

Field Detail

elementTypeback to summary
private final Type elementType
lengthback to summary
private final int length

Constructor Detail

Arrayback to summary
public Array(Type elementType, int length)

Creates a new C array layout description.

Parameters
elementType:Type

The type of fields contained in the struct.

length:int

the number of elements.

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides com.kenai.jffi.Type.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
o: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
getElementTypeback to summary
public final Type getElementType()

Returns the type of elements in the array

Returns:Type

The Type of the elements in the array

hashCodeback to summary
public int hashCode()

Overrides com.kenai.jffi.Type.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
lengthback to summary
public final int length()

Returns the number of elements in the array

Returns:int

The number of elements in the array

newArrayback to summary
public static Array newArray(Type elementType, int length)

Creates a new C array layout description.

Parameters
elementType:Type

The type of each element of the array

length:int

The length of the array.