com.goldencode.p2j.library

Class NativeString

java.lang.Object

com.goldencode.p2j.library.BaseNativeType

com.goldencode.p2j.library.NativePrimitive

com.goldencode.p2j.library.NativeString

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class NativeString
extends NativePrimitive

A descriptor for text 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 static int	BUFFER_PADDING Amount of extra bytes allocated to reduce the change of buffer overflows.
protected java.lang.String	value The stored value (defaults to empty string).

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

copyIn, copyOut, passByPointer, ptr, ref, type

Constructor Summary

Constructors

Constructor and Description
NativeString() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue() Access the data element.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
protected void	readNative(memptr ptr) Worker method to read the primitive value from the first index position of the given memory buffer.
long	render(long addr) Copy our data into a large-enough buffer in native memory and then render the buffer's address into native memory if an explicit address is provided and return the data's address to the caller.
void	setValue(java.lang.String value) Assign the data element.
int	size() Report the size (in bytes) of the native memory needed to store this instance.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.
protected void	writeNative(memptr ptr) Worker method to write the primitive value to the first index position of the given memory buffer.

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

restore

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

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

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_PADDING

private static int BUFFER_PADDING

Amount of extra bytes allocated to reduce the change of buffer overflows.

value

protected java.lang.String value

The stored value (defaults to empty string).

Constructor Detail

NativeString

public NativeString()

Default constructor.

Method Detail

getValue

public java.lang.String getValue()

Access the data element.

Returns:

The doubleing point data element.

setValue

public void setValue(java.lang.String value)

Assign the data element.

Parameters:

value - The new text data element. Ignored if null.

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.

size

public int size()

Report the size (in bytes) of the native memory needed to store this instance.

This should never be called on the server, only on the client side.

Specified by:

size in class BaseNativeType

Returns:

This is always the size of a pointer on the client platform.

render

public long render(long addr)

Copy our data into a large-enough buffer in native memory and then render the buffer's address into native memory if an explicit address is provided and return the data's address to the caller.

This should never be called on the server, only on the client side.

Overrides:

render in class NativePrimitive

Parameters:

addr - The memory address into which the address should be rendered, if the caller is supplying a buffer or 0 if the internally created buffer's address should be returned directly.

Returns:

The memory address of the buffer or 0 if there is no data to output.

readNative

protected void readNative(memptr ptr)

Worker method to read the primitive value from the first index position of the given memory buffer.

Specified by:

readNative in class NativePrimitive

Parameters:

ptr - The memory buffer to reference.

writeNative

protected void writeNative(memptr ptr)

Worker method to write the primitive value to the first index position of the given memory buffer.

Specified by:

writeNative in class NativePrimitive

Parameters:

ptr - The memory buffer to reference.