ValuePtr (CME STP (Straight Through Processing) Handler Parent 3.2.1 API)

java.lang.Object
- biz.onixs.util.ValuePtr

All Implemented Interfaces:

Comparable
```
public class ValuePtr
extends Object
implements Comparable
```
Value pointer as a region in a byte array.

Field Summary

Fields
Modifier and Type	Field and Description
`static ValuePtr`	`N` Value pointer to a byte array encoded from string "N".
`static ValuePtr`	`ONE` Value pointer to a byte array encoded from string "1".
`static ValuePtr`	`Y` Value pointer to a byte array encoded from string "Y".
`static ValuePtr`	`ZERO` Value pointer to a byte array encoded from string "0".

Constructor Summary

Constructors
Constructor and Description
`ValuePtr()` Creates undefined value pointer.
`ValuePtr(byte[] value)` Creates the value pointer.
`ValuePtr(byte[] buffer, int length)` Creates the value pointer.
`ValuePtr(byte[] buffer, int offset, int length)` Creates the value pointer.
`ValuePtr(String str)` Creates the value pointer on whole byte array encoded from string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object vp)`
`boolean`	`contentEquals(byte[] buffer, int offset)` Compares with byte array from the specified offset.
`boolean`	`contentEquals(String str)` Compares with the value pointer on whole byte array encoded from string.
`boolean`	`equals(Object obj)`
`byte[]`	`getData()` Returns whole byte array containing the value.
`int`	`getLength()` Returns length of the value in the array from offset.
`int`	`getOffset()` Returns offset of the value in the array.
`byte[]`	`getSpecifiedData()` Returns copy of pointed value as a byte array.
`int`	`hashCode()`
`boolean`	`isEmpty()` Is value empty.
`boolean`	`isSet()` Returns whether value pointer is set/defined.
`void`	`reset()` Resets value pointer to the undefined state.
`void`	`set(byte[] buffer, int offset, int length)` Sets value pointer.
`int`	`toInt()` Converts pointed value into integer.
`long`	`toLong()` Converts pointed value into long.
`String`	`toString()`
`void`	`write(OutputStream outputStream)` Writes pointed value into output stream.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - Y
```
public static final ValuePtr Y
```
    Value pointer to a byte array encoded from string "Y".
  - N
```
public static final ValuePtr N
```
    Value pointer to a byte array encoded from string "N".
  - ZERO
```
public static final ValuePtr ZERO
```
    Value pointer to a byte array encoded from string "0".
  - ONE
```
public static final ValuePtr ONE
```
    Value pointer to a byte array encoded from string "1".
- Constructor Detail
  - ValuePtr
```
public ValuePtr()
```
    Creates undefined value pointer.
  - ValuePtr
```
public ValuePtr(byte[] buffer,
                int offset,
                int length)
```
    Creates the value pointer.
    
    Parameters:
    
    buffer - byte array containing the value
    
    offset - offset of the value in the array
    
    length - length of the value in the array from offset
  - ValuePtr
```
public ValuePtr(byte[] buffer,
                int length)
```
    Creates the value pointer.
    
    Parameters:
    
    buffer - byte array containing the value which offset is equal to 0
    
    length - length of the value in the array from offset
  - ValuePtr
```
public ValuePtr(byte[] value)
```
    Creates the value pointer.
    
    Parameters:
    
    value - byte array containing the value which offset is equal to 0 and length is equal to value.length
  - ValuePtr
```
public ValuePtr(String str)
```
    Creates the value pointer on whole byte array encoded from string.
    
    Parameters:
    
    str - string from which byte array is encoded using String.getBytes()
- Method Detail
  - isSet
```
public boolean isSet()
```
    Returns whether value pointer is set/defined.
    
    Returns:
    
    is value pointer set/defined
  - reset
```
public void reset()
```
    Resets value pointer to the undefined state.
  - getSpecifiedData
```
public byte[] getSpecifiedData()
```
    Returns copy of pointed value as a byte array.
    
    Returns:
    
    copy of pointed value as a byte array
  - getData
```
public byte[] getData()
```
    Returns whole byte array containing the value.
    
    Returns:
    
    whole byte array containing the value
  - getOffset
```
public int getOffset()
```
    Returns offset of the value in the array.
    
    Returns:
    
    offset of the value in the array
  - getLength
```
public int getLength()
```
    Returns length of the value in the array from offset.
    
    Returns:
    
    length of the value in the array from offset
  - set
```
public void set(byte[] buffer,
                int offset,
                int length)
```
    Sets value pointer.
    
    Parameters:
    
    buffer - byte array containing the value
    
    offset - offset of the value in the array
    
    length - length of the value in the array from offset
    
    Throws:
    
    NullPointerException - if (buffer == null)
    
    IllegalArgumentException - if (buffer == null) or (offset + length > buffer.length) or (length < 0)
  - isEmpty
```
public boolean isEmpty()
```
    Is value empty.
    
    Returns:
    
    true in case the length of value is equal to 0, false otherwise
  - toInt
```
public int toInt()
```
    Converts pointed value into integer.
    
    Returns:
    
    pointed value as integer
  - toLong
```
public long toLong()
```
    Converts pointed value into long.
    
    Returns:
    
    pointed value as long
  - write
```
public void write(OutputStream outputStream)
           throws IOException
```
    Writes pointed value into output stream.
    
    Parameters:
    
    outputStream - output stream where the pointed value written
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
  - contentEquals
```
public boolean contentEquals(String str)
```
    Compares with the value pointer on whole byte array encoded from string.
    
    Parameters:
    
    str - string from which byte array is encoded using String.getBytes()
    
    Returns:
    
    true if the values are equal, false otherwise
  - contentEquals
```
public boolean contentEquals(byte[] buffer,
                             int offset)
```
    Compares with byte array from the specified offset.
    
    Parameters:
    
    buffer - byte array
    
    offset - offset in the array
    
    Returns:
    
    true if the values are equal, false otherwise
  - compareTo
```
public int compareTo(Object vp)
```
    Specified by:
    
    compareTo in interface Comparable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ValuePtr

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Y

N

ZERO

ONE

Constructor Detail

ValuePtr

ValuePtr

ValuePtr

ValuePtr

ValuePtr

Method Detail

isSet

reset

getSpecifiedData

getData

getOffset

getLength

set

isEmpty

toInt

toLong

write

contentEquals

contentEquals

compareTo

toString

equals

hashCode