Package jnr.ffi

Class Struct.NumberField

java.lang.Object

jnr.ffi.Struct.Member

jnr.ffi.Struct.NumberField

Direct Known Subclasses:

Struct.Address, Struct.Double, Struct.EnumField, Struct.Float, Struct.IntegerAlias, Struct.PointerField, Struct.Signed16, Struct.Signed32, Struct.Signed64, Struct.Signed8, Struct.SignedLong, Struct.Unsigned16, Struct.Unsigned32, Struct.Unsigned64, Struct.Unsigned8, Struct.UnsignedLong

Enclosing class:

Struct

public abstract class Struct.NumberField
extends Struct.Member

Base class for all Number structure fields.

Field Summary

Fields

Modifier and Type	Field	Description
private int	offset	Offset from the start of the Struct memory this field is located at.
protected Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NumberField(NativeType type)
protected	NumberField(NativeType type, Struct.Offset offset)
protected	NumberField(TypeAlias type)
protected	NumberField(TypeAlias type, Struct.Offset offset)

Method Summary

Modifier and Type	Method	Description
byte	byteValue()	Returns a byte representation of this Number.
double	doubleValue()	Returns an float representation of this Number.
float	floatValue()	Returns an float representation of this Number.
Pointer	getMemory()	Gets the memory object used to store this Member
abstract int	intValue()	Returns a int representation of this Number.
long	longValue()	Returns a long representation of this Number.
long	offset()	Gets the offset within the structure for this field.
abstract void	set(java.lang.Number value)	Sets the field to a new value.
short	shortValue()	Returns a short representation of this Number.
Struct	struct()	Gets the Struct this Member is in.
java.lang.String	toString()	Returns a string representation of this Number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

offset

private final int offset

Offset from the start of the Struct memory this field is located at.

type

protected final Type type

Constructor Detail

NumberField

protected NumberField(NativeType type)

NumberField

protected NumberField(NativeType type,
                      Struct.Offset offset)

NumberField

protected NumberField(TypeAlias type)

NumberField

protected NumberField(TypeAlias type,
                      Struct.Offset offset)

Method Detail

getMemory

public final Pointer getMemory()

Description copied from class: Struct.Member

Gets the memory object used to store this Member

Specified by:

getMemory in class Struct.Member

Returns:

a Pointer

struct

public final Struct struct()

Gets the Struct this Member is in.

Specified by:

struct in class Struct.Member

Returns:

a Struct.

offset

public final long offset()

Gets the offset within the structure for this field.

Specified by:

offset in class Struct.Member

Returns:

the offset within the structure for this field.

set

public abstract void set(java.lang.Number value)

Sets the field to a new value.

Parameters:

value - The new value.

doubleValue

public double doubleValue()

Returns an float representation of this Number.

Returns:

an float value for this Number.

floatValue

public float floatValue()

Returns an float representation of this Number.

Returns:

an float value for this Number.

byteValue

public byte byteValue()

Returns a byte representation of this Number.

Returns:

a byte value for this Number.

shortValue

public short shortValue()

Returns a short representation of this Number.

Returns:

a short value for this Number.

intValue

public abstract int intValue()

Returns a int representation of this Number.

Returns:

a int value for this Number.

longValue

public long longValue()

Returns a long representation of this Number.

Returns:

a long value for this Number.

toString

public java.lang.String toString()

Returns a string representation of this Number.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Number.