com.goldencode.p2j.library

Class NativeInteger

java.lang.Object

com.goldencode.p2j.library.BaseNativeType

com.goldencode.p2j.library.NativePrimitive

com.goldencode.p2j.library.NativeInteger

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

NativeInt8, NativeSignedInt16, NativeSignedInt32, NativeSignedInt64, NativeUnsignedInt32

public abstract class NativeInteger
extends NativePrimitive

A descriptor for integer data as an argument or return value to a native function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	array Flag to allow differential rendering between scalar and array elements.
protected long	value The stored value.

Fields inherited from class com.goldencode.p2j.library.BaseNativeType

copyIn, copyOut, passByPointer, ptr, ref, type

Constructor Summary

Constructors

Constructor and Description
NativeInteger() Default constructor.

Method Summary

Modifier and Type	Method and Description
long	getValue() Access the data element.
boolean	isInArray() Reports if this data element is an array member.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setInArray(boolean array) Defines whether or not the data element is an array member.
void	setValue(long value) Assign the data element.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.
void	writeNativeWordSize(memptr ptr) This method should be used to render signed scalar elements such that the written data is sign-extended to the word-size.

Methods inherited from class com.goldencode.p2j.library.NativePrimitive

readNative, render, restore, writeNative

Methods inherited from class com.goldencode.p2j.library.BaseNativeType

isCopyIn, isCopyOut, isPassByPointer, render, restore, setCopyIn, setCopyOut, setPassByPointer, setType, size, type

Methods inherited from class java.lang.Object

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

Field Detail

value

protected long value

The stored value.

array

private boolean array

Flag to allow differential rendering between scalar and array elements.

Constructor Detail

NativeInteger

public NativeInteger()

Default constructor.

Method Detail

getValue

public long getValue()

Access the data element.

Returns:

The integer data element.

setValue

public void setValue(long value)

Assign the data element.

Parameters:

value - The new integer data element.

isInArray

public boolean isInArray()

Reports if this data element is an array member.

Returns:

true if this is an element of an array.

setInArray

public void setInArray(boolean array)

Defines whether or not the data element is an array member.

Parameters:

array - true if this is an element of an array.

writeNativeWordSize

public void writeNativeWordSize(memptr ptr)

This method should be used to render signed scalar elements such that the written data is sign-extended to the word-size. This is how Progress 4GL handles integer data. The reason this is needed is because scalar values are passed on the stack in a "slot" that is the width of the platform's word-size. Even if the native code is expecting something smaller, the actual memory passed will have a larger, sign-extended form of the data.

This doesn't apply to non-integer data. It also doesn't apply to arrays, since there is no word-size "padding" in array elements. Each native array's element is exactly the size of the element itself and so there is no sign-extending to do.

Parameters:

ptr - The buffer in which to write at position 1.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source. The parent's state is read first.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class BaseNativeType

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination. The parent's state is written first.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class BaseNativeType

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.