ByteBucket (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.oo.lang.BaseObject
- - com.goldencode.p2j.oo.core.ByteBucket

All Implemented Interfaces:

ISupportInitialize, _BaseObject_
```
public class ByteBucket
extends BaseObject
implements ISupportInitialize
```
Business logic (converted to Java from the 4GL source code in OpenEdge/Core/ByteBucket.cls).

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.LinkedList<byte[]>`	`buckets` List of rows
`private int64`	`defaultCapacity` The initial size of the memptrs that are held in the Bucket's array.
`private static int`	`MAX_BYTES_PER_ROW` Bucket row size
`protected int64`	`position` The current position
`protected int64`	`size` The bucket size (total number of bytes)
`private long`	`writePosition` The current write position, putBytes always seems to write at the end regardless of position set

Constructor Summary

Constructors
Constructor and Description

ByteBucket()

Constructors
Constructor and Description
`ByteBucket()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`__core_ByteBucket_constructor__()` Constructor.
`void`	`__core_ByteBucket_constructor__(int64 _defaultCapacity)` Constructor.
`void`	`__core_ByteBucket_constructor__(integer _initialSize)` Constructor.
`void`	`__core_ByteBucket_constructor__(integer initialSize, int64 defaultCapacity)` Constructor.
`static void`	`__core_ByteBucket_constructor__static__()` Constructor.
`void`	`__core_ByteBucket_destructor__()` Destructor for this class.
`void`	`__core_ByteBucket_execute__()` Execute method
`void`	`clear_()` Clears/resets the ByteBucket.
`void`	`debug()` Debug method to dump out current RAW bytes into a file.
`void`	`destroy()` Destroy.
`integer`	`getByte()` Returns a byte at the current position, and increments the position marker.
`integer`	`getByte(int64 _pos)` Returns a byte at the specified position.
`object<? extends Memptr>`	`getBytes()` Returns the entire contents of this bucket as a Memptr instance.
`object<? extends Memptr>`	`getBytes(int64 size)` Returns a Memptr instance containing the specified number of bytes, starting at the current position.
`object<? extends Memptr>`	`getBytes(int64 _pos, int64 _size)` Returns a Memptr instance containing the specified number of bytes, starting at the specified position.
`int64`	`getDefaultCapacity()` Get the initial size of the memptrs that are held in the Bucket's array.
`raw`	`getHash()` Returns a hash of the current contents of the bucket.
`raw`	`getHash(object<? extends HashAlgorithmEnum> _p1)` Returns a hash of the current contents of the bucket.
`int64`	`getPosition()` Get the current read position.
`int64`	`getSize()` Returns the size of the data in the bucket.
`longchar`	`getString()` Returns a string/character representation of the entire set of bytes.
`longchar`	`getString(int64 size)` Returns a string/character representation a particular number of bytes, from the current position.
`longchar`	`getString(int64 pos, int64 size)` Returns a string/character representation a particular number of bytes, from a given start position.
`longchar`	`getString(int64 pos, int64 size, character targetCP)` Returns a string/character representation a particular number of bytes, from a given start position.
`longchar`	`getString(int64 _pos, int64 _size, character _sourceCP, character _targetCP)` Returns a string/character representation a particular number of bytes, from a given start position.
`void`	`initialize()` Initialize
`static object<? extends ByteBucket>`	`instance()` Factory method for creating a ByteBucket.
`static object<? extends ByteBucket>`	`instance(int64 _p1)` Factory method for creating a ByteBucket.
`static object<? extends ByteBucket>`	`instance(integer _p1, int64 _p2)` Factory method for creating a ByteBucket.
`void`	`putBytes_1(object<? extends Memptr> _mptr)` Copies all of the bytes from a Memptr instance into this bucket.
`void`	`putBytes(int64 _ptr, int64 _size)` Copies all of the bytes from a memptr into this bucket.
`void`	`putBytes(memptr _ptr)` Copies all of the bytes from a memptr (primitive) into this bucket.
`void`	`putBytes(object<? extends ByteBucket> _data)` Copies all of the bytes from a ByteBucket instance into this bucket.
`void`	`putString(longchar _data)` Copies all of the bytes from a longchar into this bucket.
`void`	`putString(longchar _data, character _targetCP)` Copies all of the bytes from a longchar into this bucket.
`void`	`putString(longchar data, longchar targetCP)` Copies all of the bytes from a longchar into this bucket.
`void`	`putString(object<? extends LegacyString> _data)` Copies all of the bytes from a String object into this bucket.
`private void`	`readBytes(int64 p, memptr data)` Read data into the byte array.
`void`	`resize(integer _p1)` Resizes the internal 'array' of records.
`void`	`resizeArray(integer _p1)` Resizes the internal 'array' of records.
`void`	`setPosition(int64 _var)` Set the current read position.
`private int`	`writeBytes(byte[] data, int len)` Write the content of byte array.
`private void`	`writeBytes(memptr ptr)` Write memptr data into the bucket

Methods inherited from class com.goldencode.p2j.oo.lang.BaseObject
__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, assertNotNull, assertNotNull, getLegacyClass, getNextSibling, getPrevSibling, legacyClone, legacyEquals, toLegacyString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.oo.lang._BaseObject_
__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyClone, legacyEquals, toLegacyString

- Field Detail
  - MAX_BYTES_PER_ROW
```
private static final int MAX_BYTES_PER_ROW
```
    Bucket row size
    
    See Also:
    
    Constant Field Values
  - defaultCapacity
```
private int64 defaultCapacity
```
    The initial size of the memptrs that are held in the Bucket's array. Not used in the current implementation
  - position
```
protected int64 position
```
    The current position
  - writePosition
```
private long writePosition
```
    The current write position, putBytes always seems to write at the end regardless of position set
  - size
```
protected int64 size
```
    The bucket size (total number of bytes)
  - buckets
```
protected java.util.LinkedList<byte[]> buckets
```
    List of rows
- Constructor Detail
  - ByteBucket
```
public ByteBucket()
```
- Method Detail
  - __core_ByteBucket_execute__
```
public void __core_ByteBucket_execute__()
```
    Execute method
  - getDefaultCapacity
```
public int64 getDefaultCapacity()
```
    Get the initial size of the memptrs that are held in the Bucket's array. Each memptr is the same size. Not used in the current implementation.
    
    Returns:
    
    the initial size of the memptrs that are held in the Bucket's array.
  - getPosition
```
public int64 getPosition()
```
    Get the current read position.
    
    Returns:
    
    the current read position.
  - setPosition
```
public void setPosition(int64 _var)
```
    Set the current read position.
    
    Parameters:
    
    _var - the new current read position.
  - getSize
```
public int64 getSize()
```
    Returns the size of the data in the bucket.
    
    Returns:
    
    the size of the data in the bucket.
  - __core_ByteBucket_constructor__static__
```
public static void __core_ByteBucket_constructor__static__()
```
    Constructor.
  - __core_ByteBucket_constructor__
```
public void __core_ByteBucket_constructor__()
```
    Constructor.
  - __core_ByteBucket_constructor__
```
public void __core_ByteBucket_constructor__(int64 _defaultCapacity)
```
    Constructor.
    
    Parameters:
    
    _defaultCapacity - the default capacity of the memptrs that are held in the Bucket's array.
  - __core_ByteBucket_constructor__
```
public void __core_ByteBucket_constructor__(integer _initialSize)
```
    Constructor.
    
    Parameters:
    
    _initialSize - the initial size of the memptrs that are held in the Bucket's array.
  - __core_ByteBucket_constructor__
```
public void __core_ByteBucket_constructor__(integer initialSize,
                                            int64 defaultCapacity)
```
    Constructor.
    
    Parameters:
    
    initialSize - the initial size of the memptrs that are held in the Bucket's array.
    
    defaultCapacity - the initial number of buckets (not used in the current implementation).
  - __core_ByteBucket_destructor__
```
public void __core_ByteBucket_destructor__()
```
    Destructor for this class. Cleanup/delete any created resources.
  - clear_
```
public void clear_()
```
    Clears/resets the ByteBucket. Does not de-allocate the memory, just the various pointers/counters/cursors.
  - debug
```
public void debug()
```
    Debug method to dump out current RAW bytes into a file. The file is saved in session temporary folder as "bytebucket-memptr-<object_id>.bin"
  - destroy
```
public void destroy()
```
    Destroy.
    
    Specified by:
    
    destroy in interface ISupportInitialize
  - getByte
```
public integer getByte()
```
    Returns a byte at the current position, and increments the position marker. when position is out of range method should return unknown instead of 0
    
    Returns:
    
    the byte at the current position.
  - getByte
```
public integer getByte(int64 _pos)
```
    Returns a byte at the specified position. Contrary to the 4DL documentation, does not increment the position marker when specified position is out of range method should return unknown instead of 0
    
    Parameters:
    
    _pos - the position at which to return the byte.
    
    Returns:
    
    the byte value at the position.
  - getBytes
```
public object<? extends Memptr> getBytes()
```
    Returns the entire contents of this bucket as a Memptr instance.
    
    Returns:
    
    the complete bucket data as a Memptr instance.
  - getBytes
```
public object<? extends Memptr> getBytes(int64 size)
```
    Returns a Memptr instance containing the specified number of bytes, starting at the current position.
    
    Parameters:
    
    size - the number of bytes to return.
    
    Returns:
    
    the bucket data.
  - getBytes
```
public object<? extends Memptr> getBytes(int64 _pos,
                                         int64 _size)
```
    Returns a Memptr instance containing the specified number of bytes, starting at the specified position.
    
    Parameters:
    
    _pos - the starting position.
    
    _size - the number of bytes to return.
    
    Returns:
    
    the bucket data.
  - getHash
```
public raw getHash()
```
    Returns a hash of the current contents of the bucket.
    
    Returns:
    
    the hashed value of the bucket.
  - getHash
```
public raw getHash(object<? extends HashAlgorithmEnum> _p1)
```
    Returns a hash of the current contents of the bucket.
    
    Parameters:
    
    _p1 - - the algorithm to use.
    
    Returns:
    
    the hashed value of the bucket.
  - getString
```
public longchar getString()
```
    Returns a string/character representation of the entire set of bytes.
    
    Returns:
    
    the character/string data requested.
  - getString
```
public longchar getString(int64 size)
```
    Returns a string/character representation a particular number of bytes, from the current position.
    
    Parameters:
    
    size - the size of the data (in bytes) to return.
    
    Returns:
    
    the character/string data requested.
  - getString
```
public longchar getString(int64 pos,
                          int64 size)
```
    Returns a string/character representation a particular number of bytes, from a given start position.
    
    Parameters:
    
    pos - the start position.
    
    size - the size of the data (in bytes) to return.
    
    Returns:
    
    the character/string data requested.
  - getString
```
public longchar getString(int64 pos,
                          int64 size,
                          character targetCP)
```
    Returns a string/character representation a particular number of bytes, from a given start position.
    
    Parameters:
    
    pos - the start position.
    
    size - the size of the data (in bytes) to return.
    
    targetCP - the target codepage for the character data.
    
    Returns:
    
    the character/string data requested.
  - getString
```
public longchar getString(int64 _pos,
                          int64 _size,
                          character _sourceCP,
                          character _targetCP)
```
    Returns a string/character representation a particular number of bytes, from a given start position.
    
    Parameters:
    
    _pos - the start position.
    
    _size - the size of the data (in bytes) to return.
    
    _sourceCP - the source codepage for the character data.
    
    _targetCP - the target codepage for the character data.
    
    Returns:
    
    the character/string data requested.
  - initialize
```
public void initialize()
```
    Initialize
    
    Specified by:
    
    initialize in interface ISupportInitialize
  - instance
```
public static object<? extends ByteBucket> instance()
```
    Factory method for creating a ByteBucket.
    
    Returns:
    
    a created bucket.
  - instance
```
public static object<? extends ByteBucket> instance(int64 _p1)
```
    Factory method for creating a ByteBucket.
    
    Parameters:
    
    _p1 - the size of each memptr in the array (not used in the current implementation).
    
    Returns:
    
    a created bucket.
  - instance
```
public static object<? extends ByteBucket> instance(integer _p1,
                                                    int64 _p2)
```
    Factory method for creating a ByteBucket.
    
    Parameters:
    
    _p1 - the initial size of the array (not used in the current implementation).
    
    _p2 - the size of each memptr in the array (not used in the current implementation).
    
    Returns:
    
    a created bucket.
  - putBytes
```
public void putBytes(object<? extends ByteBucket> _data)
```
    Copies all of the bytes from a ByteBucket instance into this bucket.
    
    Parameters:
    
    _data - the ByteBucket instance containing the data.
  - putBytes
```
public void putBytes(int64 _ptr,
                     int64 _size)
```
    Copies all of the bytes from a memptr into this bucket.
    
    Parameters:
    
    _ptr - the pointer to memory represented by a memptr.
    
    _size - the size of the memptr represented by the pointer value.
  - putBytes
```
public void putBytes(memptr _ptr)
```
    Copies all of the bytes from a memptr (primitive) into this bucket.
    
    Parameters:
    
    _ptr - the memptr containing the data.
  - putBytes_1
```
public void putBytes_1(object<? extends Memptr> _mptr)
```
    Copies all of the bytes from a Memptr instance into this bucket.
    
    Parameters:
    
    _mptr - the Memptr instance containing the data.
  - putString
```
public void putString(longchar _data)
```
    Copies all of the bytes from a longchar into this bucket.
    
    Parameters:
    
    _data - the longchar containing the source data.
  - putString
```
public void putString(longchar data,
                      longchar targetCP)
```
    Copies all of the bytes from a longchar into this bucket.
    
    Parameters:
    
    data - the longchar containing the source data.
    
    targetCP - the target codepage used to write data into the bucket. Defaults to UTF-8.
  - putString
```
public void putString(longchar _data,
                      character _targetCP)
```
    Copies all of the bytes from a longchar into this bucket.
    
    Parameters:
    
    _data - the longchar containing the source data.
    
    _targetCP - the target codepage used to write data into the bucket. Defaults to UTF-8.
  - putString
```
public void putString(object<? extends LegacyString> _data)
```
    Copies all of the bytes from a String object into this bucket.
    
    Parameters:
    
    _data - the String containing the source data
  - resize
```
public void resize(integer _p1)
```
    Resizes the internal 'array' of records. We can shrink down the number of rows, but not smaller than the bucket's size in bytes. Not used in the current implementation.
    
    Parameters:
    
    _p1 - the new size (number of records) for the internal structure.
  - resizeArray
```
public void resizeArray(integer _p1)
```
    Resizes the internal 'array' of records. We can shrink down the number of rows, but not smaller than the bucket's size in bytes. Not used in the current implementation.
    
    Parameters:
    
    _p1 - The new size (number of extents) for the array.
  - readBytes
```
private void readBytes(int64 p,
                       memptr data)
```
    Read data into the byte array.
    
    Parameters:
    
    p - start position.
    
    data - data.
  - writeBytes
```
private void writeBytes(memptr ptr)
```
    Write memptr data into the bucket
    
    Parameters:
    
    ptr - the source memptr
  - writeBytes
```
private int writeBytes(byte[] data,
                       int len)
```
    Write the content of byte array. The method updates the size but not the position because putBytes form ByteBucket does not change the current position.
    
    Parameters:
    
    data - the byte array data
    
    len - the length of data to write
    
    Returns:
    
    the number of bytes written

Class ByteBucket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.oo.lang.BaseObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.oo.lang._BaseObject_

Field Detail

MAX_BYTES_PER_ROW

defaultCapacity

position

writePosition

size

buckets

Constructor Detail

ByteBucket

Method Detail

__core_ByteBucket_execute__

getDefaultCapacity

getPosition

setPosition

getSize

__core_ByteBucket_constructor__static__

__core_ByteBucket_constructor__

__core_ByteBucket_constructor__

__core_ByteBucket_constructor__

__core_ByteBucket_constructor__

__core_ByteBucket_destructor__

clear_

debug

destroy

getByte

getByte

getBytes

getBytes

getBytes

getHash

getHash

getString

getString

getString

getString

getString

initialize

instance

instance

instance

putBytes

putBytes

putBytes

putBytes_1

putString

putString

putString

putString

resize

resizeArray

readBytes

writeBytes

writeBytes

__core_ByteBucket_constructorstatic