com.jniwrapper
Class Const

java.lang.Object
  |
  +--com.jniwrapper.Parameter
        |
        +--com.jniwrapper.DelegatingParameter
              |
              +--com.jniwrapper.Const

public class Const
extends com.jniwrapper.DelegatingParameter

Represents a read-only parameter. It is a wrapper for an instance of real Parameter object.


Constructor Summary
Const(Const t)
          Constructs a copy of Const instance.
Const(Parameter param)
          Constructs Const object taking wrapping Parameter object.
 
Method Summary
protected  void acceptIOPerformer(IOPerformer performer, DataBuffer source, int initialOffset, boolean isReadOperation, boolean invokedByCallback)
          Realization of a Visitor pattern for parameter IO.
 java.lang.Object clone()
           
protected  DataBuffer getDataBuffer()
          Returns current data storage.
protected  int getDataBufferOffset()
          Returns current offset within data storage.
 int getLength()
          Returns a length of the parameter in memory.
 void pop(DataBuffer stackBuffer, int offset, boolean invokedByCallback)
          Default implementation, which does nothing as 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.
protected  void setDataBuffer(DataBuffer newSource, int newOffset)
          Sets the data buffer this parameter should use to store data and an offset in bytes within that buffer.
 java.lang.String toString()
           
 void write(DataBuffer stackBuffer, int offset, boolean invokedByCallback)
          Writes this parameter to a specified data source.
 
Methods inherited from class com.jniwrapper.Parameter
asReturnValue, equals, getAlignedLength, getAlignmentRequirement, indent, read, toByteArray, write
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Const

public Const(Parameter param)
Constructs Const object taking wrapping Parameter object.


Const

public Const(Const t)
Constructs a copy of Const instance.

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 com.jniwrapper.DelegatingParameter
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 com.jniwrapper.DelegatingParameter
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 com.jniwrapper.DelegatingParameter
MemoryAccessViolationException

pop

public void pop(DataBuffer stackBuffer,
                int offset,
                boolean invokedByCallback)
         throws MemoryAccessViolationException
Description copied from class: Parameter
Default implementation, which does nothing as most primitive types do nothing on pop. Reads a parameter from a function stack.

Overrides:
pop in class com.jniwrapper.DelegatingParameter
MemoryAccessViolationException

clone

public java.lang.Object clone()
Specified by:
clone in class Parameter

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

acceptIOPerformer

protected void acceptIOPerformer(IOPerformer performer,
                                 DataBuffer source,
                                 int initialOffset,
                                 boolean isReadOperation,
                                 boolean invokedByCallback)
Description copied from class: Parameter
Realization of a Visitor pattern for parameter IO. A performer is responsible for I/Oing 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 Parameter
Parameters:
performer - 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

setDataBuffer

protected void setDataBuffer(DataBuffer newSource,
                             int newOffset)
Description copied from class: Parameter
Sets the data buffer this parameter should use to store data and an offset in bytes within that buffer.

Overrides:
setDataBuffer in class Parameter

getDataBuffer

protected DataBuffer getDataBuffer()
Description copied from class: Parameter
Returns current data storage.

Overrides:
getDataBuffer in class Parameter

getDataBufferOffset

protected int getDataBufferOffset()
Description copied from class: Parameter
Returns current offset within data storage.

Overrides:
getDataBufferOffset in class Parameter

getLength

public int getLength()
Description copied from class: Parameter
Returns a length of the parameter in memory. This method is analogous to C sizeof() operator.

Specified by:
getLength in class Parameter