jnr.ffi.byref
Class ShortByReference

java.lang.Object
  java.lang.Number
      jnr.ffi.byref.AbstractNumberReference<Short>
          jnr.ffi.byref.ShortByReference

All Implemented Interfaces:

Serializable, ByReference<Short>

public final class ShortByReference
extends AbstractNumberReference<Short>

ShortByReference is used when the address of a primitive short value must be passed as a parameter to a function.

For example, the following C code,

 extern void get_a(short * ap);

 short foo(void) {
     short a;
     // pass a reference to 'a' so get_a() can fill it out
     get_a(&a);

     return a;
 }
 
 

Would be declared in java as

 interface Lib {
     void get_a(@Out ShortByReference ap);
 }
 
 

and used like this

 ShortByReference ap = new ShortByReference();
 lib.get_a(ap);
 System.out.printf("a from lib=%d\n", a.getValue());
 

See Also:

Serialized Form

Constructor Summary

ShortByReference()
Creates a new reference to a short value initialized to zero.

ShortByReference(short value)
Creates a new reference to a short value.

ShortByReference(Short value)
Creates a new reference to a short value.

Method Summary

void	marshal(Pointer buffer, long offset) Copies the short value to native memory
int	nativeSize(Runtime runtime) Gets the native size of type of reference in bytes.
void	unmarshal(Pointer buffer, long offset) Copies the short value from native memory

Methods inherited from class jnr.ffi.byref.AbstractNumberReference

byteValue, checkNull, doubleValue, floatValue, getValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortByReference

public ShortByReference()

Creates a new reference to a short value initialized to zero.

ShortByReference

public ShortByReference(Short value)

Creates a new reference to a short value.

Parameters:

value - the initial native value

ShortByReference

public ShortByReference(short value)

Creates a new reference to a short value.

Parameters:

value - the initial native value

Method Detail

marshal

public void marshal(Pointer buffer,
                    long offset)

Copies the short value to native memory

Parameters:

buffer - the native memory buffer

unmarshal

public void unmarshal(Pointer buffer,
                      long offset)

Copies the short value from native memory

Parameters:

buffer - the native memory buffer.

nativeSize

public final int nativeSize(Runtime runtime)

Gets the native size of type of reference in bytes.

Returns:

the size of a byte in bytes