XByteSequence (Talon 3.16.63 API)

java.lang.Object
- com.neeve.lang.XByteSequence

All Implemented Interfaces:

XByteIterator
```
public final class XByteSequence
extends Object
implements XByteIterator
```
Wraps a set of bytes representing a serialized sequence of bytes.
An XByteSequence stores a set of bytes in native memory. Its views the stored bytes as a sequence of bytes and provides methods to read and modify these values.

To use an instance of this class, the user first needs to initialize the instance by wrapping it around a memory region containing the serialized byte sequence. This is done using one of the wrap() or setFrom() methods. Once the instance has been initialized, the user can use the data accessor and modification methods to access and/or modify the the sequence managed by this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static XByteSequence`	`create()` Create a byte sequence
`int`	`getTo(byte[] val, int offset)` Copy the serialized byte sequence to a byte array object
`int`	`getTo(long addr, int offset)` Copy the serialized byte sequence to a native memory region
`int`	`getTo(com.neeve.quark.QuarkBuffer val, int offset)` Copy the serialized byte sequence to a `QuarkBuffer`
`boolean`	`hasNext()` Implementation of `XByteIterator.hasNext()`
`boolean`	`isInitialized()` Get if the sequence has been initialized or nor
`boolean`	`isOwned()` Get if the sequence was initialized by copying or wrapping
`XByteIterator`	`iterator()` Get an iterator to iterate over a byte sequence values
`byte`	`next()` Implementation of `XByteIterator.next()`
`int`	`numElements()` Get the number of elements in a byte sequence
`void`	`remove()` Implementation of `XByteIterator.remove()`
`XByteSequence`	`reset()` Reset a byte sequence
`int`	`serializedLength()` Get the serialized length of a byte sequence
`XByteSequence`	`setFrom(long addr, int offset, int len)` Initialize a sequence by copying a byte sequence serialized in a native memory region to a private backing store
`XByteSequence`	`setFrom(com.neeve.quark.QuarkBuffer buffer, int offset, int len)` Initialize a sequence by copying a byte sequence serialized in a `QuarkBuffer`
`XByteSequence`	`setFrom(XByteIterator iterator)` Initialize a sequence by copying a byte sequence using a `XByteIterator`
`XByteSequence`	`setFrom(XByteSequence sequence)` Initialize a sequence by copying a byte sequence from a `XByteSequence`
`XByteIterator`	`toFirst()` Implementation of `XByteIterator.toFirst()`
`XByteSequence`	`wrap(long addr, int offset, int len)` Initialize a sequence by wrapping it around a byte sequence serialized in a native memory region
`XByteSequence`	`wrap(com.neeve.quark.QuarkBuffer buffer, int offset, int len)` Initialize a sequence by wrapping it around a byte sequence serialized in a `QuarkBuffer`

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

- Method Detail
  - create
```
public static final XByteSequence create()
```
    Create a byte sequence
  - isInitialized
```
public final boolean isInitialized()
```
    Get if the sequence has been initialized or nor
    
    Returns:
    
    true if sequence has been initialized and false if not
  - isOwned
```
public final boolean isOwned()
```
    Get if the sequence was initialized by copying or wrapping
    
    Returns:
    
    true if sequence was initialized by copying (setFrom() method) and false if initialized by wrapping (wrap() method)
  - toFirst
```
public XByteIterator toFirst()
```
    Implementation of XByteIterator.toFirst()
    
    Specified by:
    
    toFirst in interface XByteIterator
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - hasNext
```
public final boolean hasNext()
```
    Implementation of XByteIterator.hasNext()
    
    Specified by:
    
    hasNext in interface XByteIterator
    
    Returns:
    
    true if the iterator has more elements.
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - next
```
public final byte next()
```
    Implementation of XByteIterator.next()
    
    Specified by:
    
    next in interface XByteIterator
    
    Returns:
    
    the next element in the iteration.
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - remove
```
public final void remove()
```
    Implementation of XByteIterator.remove()
    
    Specified by:
    
    remove in interface XByteIterator
  - wrap
```
public final XByteSequence wrap(long addr,
                                int offset,
                                int len)
```
    Initialize a sequence by wrapping it around a byte sequence serialized in a native memory region
    
    Parameters:
    
    addr - The address of the memory region containing the serialized byte sequence
    
    offset - The offset from the start of the memory region where the serialized sequence is stored
    
    len - The length of the serialized byte sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence's backing data pointers to a native memory region containing the serialized byte sequence. This method does not make a copy of the serialized sequence. Therefore, the user must ensure that the source is not modified or freed as long as the sequence is in active use or reset() is invoked.
    
    This method can be invoked repeatedly with different backing stores. Each invocation resets all internal markers.
    
    This method implictly invokes reset() as part of its processing
  - wrap
```
public final XByteSequence wrap(com.neeve.quark.QuarkBuffer buffer,
                                int offset,
                                int len)
```
    Initialize a sequence by wrapping it around a byte sequence serialized in a QuarkBuffer
    
    Parameters:
    
    buffer - The buffer containing the serialized byte sequence
    
    offset - The offset into the buffer where the serialized byte sequence is stored
    
    len - The length of the serialized byte sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence's backing data pointers to the section of a QuarkBuffer containing the serialized byte sequence. This method does not make a copy of the serialized sequence. Therefore, the user must ensure that the source is not modified or freed as long as the sequence is in active use or reset() is invoked.
    
    This method can be invoked repeatedly with different backing stores. Each invocation resets all internal markers.
    
    This method implictly invokes reset() as part of its processing
  - setFrom
```
public final XByteSequence setFrom(long addr,
                                   int offset,
                                   int len)
```
    Initialize a sequence by copying a byte sequence serialized in a native memory region to a private backing store
    
    Parameters:
    
    addr - The address of the memory region containing the serialized byte sequence
    
    offset - The offset from the start of the memory region where the serialized sequence is stored
    
    len - The length of the serialized byte sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence by copying a byte sequence serialized in a native memory region to a backing store that is private to the sequence object. Once done with using the sequence instance, the user must invoke reset() to release the resources held by the backing store or release the sequence object to the garbage collector in which case the backing store resources will be released when the object is collected by the garbage collector.
    
    This method can be invoked repeatedly with different backing stores. Each invocation invokes reset() and performs a fresh initialization of the backing store.
  - setFrom
```
public final XByteSequence setFrom(com.neeve.quark.QuarkBuffer buffer,
                                   int offset,
                                   int len)
```
    Initialize a sequence by copying a byte sequence serialized in a QuarkBuffer
    
    Parameters:
    
    buffer - The buffer containing the serialized byte sequence
    
    offset - The offset into the buffer where the serialized byte sequence is stored
    
    len - The length of the serialized byte sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence by copying a byte sequence serialized in a QuarkBuffer to a backing store that is private to the sequence object. Once done with using the sequence instance, the user must invoke reset() to release the resources held by the backing store or release the sequence object to the garbage collector in which case the backing store resources will be released when the object is collected by the garbage collector.
    
    This method can be invoked repeatedly with different backing stores. Each invocation invokes reset() and performs a fresh initialization of the backing store.
  - setFrom
```
public final XByteSequence setFrom(XByteSequence sequence)
```
    Initialize a sequence by copying a byte sequence from a XByteSequence
    
    Parameters:
    
    iterator - The source sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence by copying a byte sequence from a XByteSequence to a backing store that is private to the sequence object. Once done with using the sequence instance, the user must invoke reset() to release the resources held by the backing store or release the sequence object to the garbage collector in which case the backing store resources will be released when the object is collected by the garbage collector.
    
    This method can be invoked repeatedly with different backing stores. Each invocation invokes reset() and performs a fresh initialization of the backing store.
  - setFrom
```
public final XByteSequence setFrom(XByteIterator iterator)
```
    Initialize a sequence by copying a byte sequence using a XByteIterator
    
    Parameters:
    
    iterator - The iterator to use to access the sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method initializes a sequence by copying a byte sequence using a XByteIterator to a backing store that is private to the sequence object. Once done with using the sequence instance, the user must invoke reset() to release the resources held by the backing store or release the sequence object to the garbage collector in which case the backing store resources will be released when the object is collected by the garbage collector.
    
    This method can be invoked repeatedly with different backing stores. Each invocation invokes reset() and performs a fresh initialization of the backing store.
  - numElements
```
public final int numElements()
```
    Get the number of elements in a byte sequence
    
    Returns:
    
    The number of elements in the sequence
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - serializedLength
```
public final int serializedLength()
```
    Get the serialized length of a byte sequence
    
    Returns:
    
    The serialized length of the sequence
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - getTo
```
public final int getTo(byte[] val,
                       int offset)
```
    Copy the serialized byte sequence to a byte array object
    
    Parameters:
    
    val - The destination array object to copy to
    
    offset - The offset into the destination array to copy to
    
    Returns:
    
    The number of bytes copied
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - getTo
```
public final int getTo(long addr,
                       int offset)
```
    Copy the serialized byte sequence to a native memory region
    
    Parameters:
    
    addr - The destination memory region to copy to
    
    offset - The offset into memory region to copy to
    
    Returns:
    
    The number of bytes copied
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - getTo
```
public final int getTo(com.neeve.quark.QuarkBuffer val,
                       int offset)
```
    Copy the serialized byte sequence to a QuarkBuffer
    
    Parameters:
    
    val - The destination buffer to copy to
    
    offset - The offset into buffer to copy to
    
    Returns:
    
    The number of bytes copied
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - iterator
```
public final XByteIterator iterator()
```
    Get an iterator to iterate over a byte sequence values
    
    Returns:
    
    The returned iterator
    
    Throws:
    
    IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom method
  - reset
```
public final XByteSequence reset()
```
    Reset a byte sequence
    
    Returns:
    
    Returns this for invocation chaining
    This method resets a byte sequence. It releases all resources used by the sequence's private backing store

Class XByteSequence

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

isInitialized

isOwned

toFirst

hasNext

next

remove

wrap

wrap

setFrom

setFrom

setFrom

setFrom

numElements

serializedLength

getTo

getTo

getTo

iterator

reset