public final class XShortSequence extends Object implements XShortIterator
An XShortSequence stores a set of bytes in native memory. Its views
the stored bytes as a sequence of shorts 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 short 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.
| Modifier and Type | Method and Description |
|---|---|
static XShortSequence |
create()
Create a new short sequence reader
|
int |
getTo(byte[] val,
int offset)
Copy the serialized short sequence to a byte array object
|
int |
getTo(long addr,
int offset)
Copy the serialized short sequence to a native memory region
|
int |
getTo(com.neeve.quark.QuarkBuffer val,
int offset)
Copy the serialized short sequence to a
QuarkBuffer |
int |
getTo(short[] val,
int offset)
Copy the serialized short sequence to a short array object
|
boolean |
hasNext()
Implementation of
XShortIterator.hasNext() |
boolean |
isInitialized()
Get if the sequence has been initialized or nor
|
boolean |
isOwned()
Get if the sequence was initialized by copying or wrapping
|
XShortIterator |
iterator()
Get an iterator to iterate over a short sequence values
|
short |
next()
Implementation of
XShortIterator.next() |
int |
numElements()
Get the number of elements in a short sequence
|
void |
remove()
Implementation of
XShortIterator.remove() |
XShortSequence |
reset()
Reset a short sequence
|
int |
serializedLength()
Get the serialized length of a short sequence
|
XShortSequence |
setFrom(long addr,
int offset,
int len)
Initialize a sequence by copying a short sequence serialized in a native memory region to a private backing store
|
XShortSequence |
setFrom(com.neeve.quark.QuarkBuffer buffer,
int offset,
int len)
Initialize a sequence by copying a short sequence serialized in a
QuarkBuffer |
XShortSequence |
setFrom(XShortIterator iterator)
Initialize a sequence by copying a short sequence using a
XShortIterator |
XShortSequence |
setFrom(XShortSequence sequence)
Initialize a sequence by copying a short sequence from a
XShortSequence |
XShortIterator |
toFirst()
Implementation of
XShortIterator.toFirst() |
XShortSequence |
wrap(long addr,
int offset,
int len)
Initialize a sequence by wrapping it around a short sequence serialized in a native memory region
|
XShortSequence |
wrap(com.neeve.quark.QuarkBuffer buffer,
int offset,
int len)
Initialize a sequence by wrapping it around a short sequence serialized in a
QuarkBuffer |
public static final XShortSequence create()
public final boolean isInitialized()
public final boolean isOwned()
public XShortIterator toFirst()
XShortIterator.toFirst()toFirst in interface XShortIteratorIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final boolean hasNext()
XShortIterator.hasNext()hasNext in interface XShortIteratorIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final short next()
XShortIterator.next()next in interface XShortIteratorIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final void remove()
XShortIterator.remove()remove in interface XShortIteratorpublic final XShortSequence wrap(long addr, int offset, int len)
addr - The address of the memory region containing the serialized short sequenceoffset - The offset from the start of the memory region where the serialized sequence is storedlen - The length of the serialized short sequence
This method initializes a sequence's backing data pointers to a native memory region containing
the serialized short 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
public final XShortSequence wrap(com.neeve.quark.QuarkBuffer buffer, int offset, int len)
QuarkBufferbuffer - The buffer containing the serialized short sequenceoffset - The offset into the buffer where the serialized short sequence is storedlen - The length of the serialized short sequence
This method initializes a sequence's backing data pointers to the section of a QuarkBuffer
containing the serialized short 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
public final XShortSequence setFrom(long addr, int offset, int len)
addr - The address of the memory region containing the serialized short sequenceoffset - The offset from the start of the memory region where the serialized sequence is storedlen - The length of the serialized short sequence
This method initializes a sequence by copying a short 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.
public final XShortSequence setFrom(com.neeve.quark.QuarkBuffer buffer, int offset, int len)
QuarkBufferbuffer - The buffer containing the serialized short sequenceoffset - The offset into the buffer where the serialized short sequence is storedlen - The length of the serialized short sequence
This method initializes a sequence by copying a short 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.
public final XShortSequence setFrom(XShortSequence sequence)
XShortSequenceiterator - The source sequence
This method initializes a sequence by copying a short sequence from a XShortSequence
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.
public final XShortSequence setFrom(XShortIterator iterator)
XShortIteratoriterator - The iterator to use to access the sequence
This method initializes a sequence by copying a short sequence using a XShortIterator
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.
public final int numElements()
IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final int serializedLength()
IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final int getTo(short[] val,
int offset)
val - The destination array object to copy tooffset - The offset into the destination array to copy toIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final int getTo(byte[] val,
int offset)
val - The destination array object to copy tooffset - The offset into the destination array to copy toIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final int getTo(long addr,
int offset)
addr - The destination memory region to copy tooffset - The offset into memory region to copy toIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final int getTo(com.neeve.quark.QuarkBuffer val,
int offset)
QuarkBufferval - The destination buffer to copy tooffset - The offset into buffer to copy toIllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final XShortIterator iterator()
IllegalStateException - Thrown if the sequence has not been initialized via a wrap() or setFrom methodpublic final XShortSequence reset()
This method resets a short sequence. It releases all resources used by the sequence's private backing store
Copyright © 2019 Neeve Research, LLC. All Rights Reserved.