com.goldencode.p2j.library

Class Signature

java.lang.Object

com.goldencode.p2j.library.Signature

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class Signature
extends java.lang.Object
implements java.io.Externalizable

Container for all info related to a native function's arguments and return value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private BaseNativeType[]	args Argument list in left to right order, with one element for each argument.
private int	error If not LibraryManager.ERROR_NONE, then this code describes the failure.
private boolean	noInvoke Flag indicating this API will never be invoked, just resolved.
private int	platform The platform type on which the client code is running.
private BaseNativeType	retval Return value (will not be null if the function returns a value).

Constructor Summary

Constructors

Constructor and Description
Signature() Default constructor.
Signature(int numArgs) Create a new native function signature.

Method Summary

Modifier and Type	Method and Description
BaseNativeType	getArgument(int idx) Obtains a specific argument for this native function.
int	getArgumentSize() Reports the number of arguments for this native function.
int	getErrorCode() Obtains the constant that defines the error code from the invocation attempt.
int	getPlatform() Obtains the constant that defines the platform type on which the client is running.
BaseNativeType	getReturnValue() Obtains the descriptor for the return value.
boolean	isNoInvoke() Get the state of the no-invoke flag.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setArgument(BaseNativeType value, int idx) Assigns the argument to the given index position for this native function.
void	setArgumentSize(int numArgs) Defines the number of arguments for this native function.
void	setErrorCode(int error) Assigns the constant that defines the error code from the invocation attempt.
void	setNoInvoke(boolean noInvoke) Set the state of the no-invoke flag.
void	setPlatform(int platform) Assigns the constant that defines the platform type on which the client is running.
void	setReturnValue(BaseNativeType retval) Assigns the descriptor for the return value.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

args

private BaseNativeType[] args

Argument list in left to right order, with one element for each argument.

retval

private BaseNativeType retval

Return value (will not be null if the function returns a value).

platform

private int platform

The platform type on which the client code is running.

error

private int error

If not LibraryManager.ERROR_NONE, then this code describes the failure.

noInvoke

private boolean noInvoke

Flag indicating this API will never be invoked, just resolved.

Constructor Detail

Signature

public Signature()

Default constructor.

Signature

public Signature(int numArgs)

Create a new native function signature.

Parameters:

numArgs - The non-negative number of arguments for the native function.

Throws:

java.lang.IllegalArgumentException - If the number of arguments was specified as a negative number.

Method Detail

getArgumentSize

public int getArgumentSize()

Reports the number of arguments for this native function.

Returns:

The number of arguments (will always be 0 or more).

setArgumentSize

public void setArgumentSize(int numArgs)

Defines the number of arguments for this native function.

Parameters:

numArgs - The number of arguments (must always be 0 or more).

Throws:

java.lang.IllegalArgumentException - If the number of arguments was specified as a negative number.

getArgument

public BaseNativeType getArgument(int idx)

Obtains a specific argument for this native function.

Parameters:

idx - The 0-based index number of the argument to obtain.

Returns:

The specified argument if it has been already initialized and the index is within range. null if the argument has not yet been defined but is within the valid range.

Throws:

java.lang.IllegalArgumentException - If the argument index is out of range.

setArgument

public void setArgument(BaseNativeType value,
                        int idx)

Assigns the argument to the given index position for this native function.

Parameters:

value - The argument to assign. If this is null, it effectively clears the state for that index position.

idx - The 0-based index number of the argument to assign.

Throws:

java.lang.IllegalArgumentException - If the argument index is out of range.

getReturnValue

public BaseNativeType getReturnValue()

Obtains the descriptor for the return value.

Returns:

The descriptor or null if there is no defined return value.

setReturnValue

public void setReturnValue(BaseNativeType retval)

Assigns the descriptor for the return value.

Parameters:

retval - The descriptor to assign. If this is null, it effectively clears the state for the return value.

getPlatform

public int getPlatform()

Obtains the constant that defines the platform type on which the client is running.

Returns:

The client platform type.

setPlatform

public void setPlatform(int platform)

Assigns the constant that defines the platform type on which the client is running.

Parameters:

platform - The new client platform type.

getErrorCode

public int getErrorCode()

Obtains the constant that defines the error code from the invocation attempt. If this is not LibraryManager.ERROR_NONE, then a failure has occurred and this code describes the failure.

Returns:

The error code, if any.

setErrorCode

public void setErrorCode(int error)

Assigns the constant that defines the error code from the invocation attempt.

Parameters:

error - The new error code. If this is not LibraryManager.ERROR_NONE, then a failure has occurred and this code describes the failure.

isNoInvoke

public boolean isNoInvoke()

Get the state of the no-invoke flag.

Returns:

See above.

setNoInvoke

public void setNoInvoke(boolean noInvoke)

Set the state of the no-invoke flag.

Parameters:

noInvoke - The new value of this flag.

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

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

Parameters:

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

Throws:

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