Top Description Inners Fields Constructors Methods
com.kenai.jffi

public final Class Struct

extends Aggregate
Class Inheritance
Imports
java.lang.ref.ReferenceQueue, .WeakReference, java.util.Arrays, .List, .Map, java.util.concurrent.ConcurrentHashMap

Describes the layout of a C struct

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final Type[]
private static final Map<List<Type>, Struct.StructReference>
private static final ReferenceQueue<Struct>

Constructor Summary

AccessConstructor and Description
private
Struct(Foreign foreign, Type...
The fields contained in the struct.
fields
)

Creates a new C struct layout description.

public
Struct(Type...
The fields contained in the struct.
fields
)

Deprecated
Creates a new C struct 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 int
hashCode()

Overrides com.kenai.jffi.Type.hashCode.

Returns a hash code value for this object.
public static Struct
newStruct(Type... fields)

Inherited from com.kenai.jffi.Aggregate:
disposefinalizegetTypeInfo

Field Detail

fieldsback to summary
private final Type[] fields
Annotations
@SuppressWarnings:UnusedDeclaration, FieldCanBeLocal
structCacheback to summary
private static final Map<List<Type>, Struct.StructReference> structCache
structReferenceQueueback to summary
private static final ReferenceQueue<Struct> structReferenceQueue

Constructor Detail

Structback to summary
private Struct(Foreign foreign, Type... fields)

Creates a new C struct layout description.

Parameters
fields:Type[]

The fields contained in the struct.

Structback to summary
public Struct(Type... fields)

Deprecated

Creates a new C struct layout description.

Parameters
fields:Type[]

The fields contained in the struct.

Annotations
@Deprecated

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
hashCodeback to summary
public int hashCode()

Overrides com.kenai.jffi.Type.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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
newStructback to summary
public static Struct newStruct(Type... fields)
com.kenai.jffi back to summary

private final Class Struct.StructReference

extends WeakReference<Struct>
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv List<Type>

Constructor Summary

AccessConstructor and Description
private
StructReference(Struct struct, ReferenceQueue<? super Struct> referenceQueue, List<Type> fieldsList)

Field Detail

fieldsListback to summary
pack-priv List<Type> fieldsList

Constructor Detail

StructReferenceback to summary
private StructReference(Struct struct, ReferenceQueue<? super Struct> referenceQueue, List<Type> fieldsList)