com.jniwrapper

Class Unused

java.lang.Object

com.jniwrapper.Parameter

com.jniwrapper.DelegatingParameter

com.jniwrapper.Unused

public class Unused
extends DelegatingParameter

Represents a parameter which is not accessed in a native function. It's a wrapper for real Parameter object.

Field Summary

Fields inherited from class com.jniwrapper.Parameter

LICENSE_TYPE, V

Constructor Summary

Constructors

Constructor and Description
Unused(Parameter param) Constructs a new unused parameter using a given sample.

Method Summary

Modifier and Type	Method and Description
protected void	acceptIOPerformer(IOPerformer performer, DataBuffer source, int initialOffset, boolean isReadOperation, boolean invokedByCallback) Implementation of a Visitor pattern for parameter IO.
java.lang.Object	clone()
java.lang.String	getDebugInfo() Return debug info for JNIWrapper parameter.
void	pop(DataBuffer stackBuffer, int offset, boolean invokedByCallback) Default implementation that does nothing because most primitive types do nothing on pop.
void	push(DataBuffer stackBuffer, int offset, boolean invokedByCallback) Writes a parameter to a function stacks.
void	read(DataBuffer stackBuffer, int offset, boolean invokedByCallback) Reads this parameter from a specified data source.
void	write(DataBuffer stackBuffer, int offset, boolean invokedByCallback) Writes this parameter to a specified data source.

Methods inherited from class com.jniwrapper.DelegatingParameter

getDataBuffer, getDataBufferOffset, getLength, getValueObject, setDataBuffer, setValueObject, toString

Methods inherited from class com.jniwrapper.Parameter

asReturnValue, dataBufferAssigned, equals, getAlignedLength, getAlignmentRequirement, hashCode, indent, read, read, toByteArray, write

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Unused

public Unused(Parameter param)

Constructs a new unused parameter using a given sample.

Parameters:

param - sample.

Method Detail

write

public void write(DataBuffer stackBuffer,
                  int offset,
                  boolean invokedByCallback)
           throws MemoryAccessViolationException

Description copied from class: Parameter

Writes this parameter to a specified data source.

Overrides:

write in class DelegatingParameter

Throws:

MemoryAccessViolationException

read

public void read(DataBuffer stackBuffer,
                 int offset,
                 boolean invokedByCallback)
          throws MemoryAccessViolationException

Description copied from class: Parameter

Reads this parameter from a specified data source.

Overrides:

read in class DelegatingParameter

Throws:

MemoryAccessViolationException

push

public void push(DataBuffer stackBuffer,
                 int offset,
                 boolean invokedByCallback)
          throws MemoryAccessViolationException

Description copied from class: Parameter

Writes a parameter to a function stacks.

Overrides:

push in class DelegatingParameter

Throws:

MemoryAccessViolationException

pop

public void pop(DataBuffer stackBuffer,
                int offset,
                boolean invokedByCallback)
         throws MemoryAccessViolationException

Description copied from class: Parameter

Default implementation that does nothing because most primitive types do nothing on pop. Reads a parameter from a function stack.

Overrides:

pop in class DelegatingParameter

Throws:

MemoryAccessViolationException

acceptIOPerformer

protected void acceptIOPerformer(IOPerformer performer,
                                 DataBuffer source,
                                 int initialOffset,
                                 boolean isReadOperation,
                                 boolean invokedByCallback)

Description copied from class: Parameter

Implementation of a Visitor pattern for parameter IO. A performer is responsible for reading and writing the parameter. Users implementing a complex parameter from scratch (i.e. not by extending a pre-existing class such as Structure or Pointer) may wish to override this method to make a performer visit object internal parts.

Overrides:

acceptIOPerformer in class DelegatingParameter

Parameters:

performer - a visitor responsible for I/Oing the parameter.

source - data buffer for I/O operation.

initialOffset - I/O operation offset of this parameter in the buffer.

clone

public java.lang.Object clone()

Specified by:

clone in class Parameter

getDebugInfo

public java.lang.String getDebugInfo()

Description copied from class: Parameter

Return debug info for JNIWrapper parameter.

Overrides:

getDebugInfo in class DelegatingParameter

Returns:

debug info