@InterfaceAudience.Private @InterfaceStability.Evolving public abstract class AbstractPositionedByteRange extends AbstractByteRange implements PositionedByteRange
SimpleByteRange
implementation with position support. position
is considered transient, not fundamental to the definition of the range, and does not participate
in AbstractByteRange.compareTo(ByteRange)
, AbstractByteRange.hashCode()
, or AbstractByteRange.equals(Object)
.
Position
is retained by copy operations.Modifier and Type | Field and Description |
---|---|
protected int |
limit |
protected int |
position
The current index into the range.
|
bytes, hash, length, offset, UNSET_HASH_VALUE
Constructor and Description |
---|
AbstractPositionedByteRange() |
Modifier and Type | Method and Description |
---|---|
byte |
get()
Retrieve the next byte from this range.
|
PositionedByteRange |
get(byte[] dst)
Fill
dst with bytes from the range, starting from position . |
PositionedByteRange |
get(byte[] dst,
int offset,
int length)
Fill
dst with bytes from the range, starting from the current position . |
PositionedByteRange |
get(int index,
byte[] dst)
Fill
dst with bytes from the range, starting from index . |
PositionedByteRange |
get(int index,
byte[] dst,
int offset,
int length)
Fill
dst with bytes from the range, starting from index . |
int |
getInt()
Retrieve the next int value from this range.
|
int |
getLimit()
Return the current limit n
|
long |
getLong()
Retrieve the next long value from this range.
|
int |
getPosition()
The current
position marker. |
int |
getRemaining()
The number of bytes remaining between position and the end of the range.
|
short |
getShort()
Retrieve the next short value from this range.
|
long |
getVLong()
Retrieve the next long value, which is stored as VLong, from this range
|
byte |
peek()
Retrieve the next byte from this range without incrementing position.
|
PositionedByteRange |
set(byte[] bytes)
Reuse this
ByteRange over a new byte[]. |
PositionedByteRange |
set(byte[] bytes,
int offset,
int length)
Reuse this
ByteRange over a new byte[]. |
PositionedByteRange |
set(int capacity)
Reuse this
ByteRange over a new byte[]. |
PositionedByteRange |
setLength(int length)
Update the length of this range.
|
PositionedByteRange |
setLimit(int limit)
Limits the byte range upto a specified value.
|
PositionedByteRange |
setOffset(int offset)
Update the beginning of this range.
|
PositionedByteRange |
setPosition(int position)
Update the
position index. |
clearHashCache, compareTo, deepCopySubRangeTo, deepCopyTo, deepCopyToNewArray, equals, get, getBytes, getInt, getLength, getLong, getOffset, getShort, getVLong, getVLongSize, hashCode, isEmpty, isEmpty, isHashCached, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
deepCopy, put, put, put, put, put, put, putInt, putInt, putLong, putLong, putShort, putShort, putVLong, shallowCopy, shallowCopySubRange, unset
deepCopySubRangeTo, deepCopyTo, deepCopyToNewArray, get, getBytes, getInt, getLength, getLong, getOffset, getShort, getVLong, isEmpty, putVLong
compareTo
protected int position
ByteBuffer
position, it points to the
next value that will be read/written in the array. It provides the appearance of being
0-indexed, even though its value is calculated according to offset.
Position is considered transient and does not participate in AbstractByteRange.equals(Object)
or
AbstractByteRange.hashCode()
comparisons.
protected int limit
public AbstractPositionedByteRange()
public PositionedByteRange set(int capacity)
ByteRange
ByteRange
over a new byte[]. offset
is set to 0 and length
is set to capacity
.set
in interface ByteRange
set
in interface PositionedByteRange
set
in class AbstractByteRange
capacity
- the size of a new byte[]. npublic PositionedByteRange set(byte[] bytes)
ByteRange
ByteRange
over a new byte[]. offset
is set to 0 and length
is set to bytes.length
. A null bytes
IS supported, in which case this method
will behave equivalently to ByteRange.unset()
.set
in interface ByteRange
set
in interface PositionedByteRange
set
in class AbstractByteRange
bytes
- the array to wrap. npublic PositionedByteRange set(byte[] bytes, int offset, int length)
ByteRange
ByteRange
over a new byte[]. A null bytes
IS supported, in which
case this method will behave equivalently to ByteRange.unset()
, regardless of the values of
offset
and length
.set
in interface ByteRange
set
in interface PositionedByteRange
set
in class AbstractByteRange
bytes
- The array to wrap.offset
- The offset into bytes
considered the beginning of this range.length
- The length of this range.public PositionedByteRange setOffset(int offset)
offset + length
may not be greater than
bytes.length
. Resets position
to 0. n * the new start of this range.setOffset
in interface ByteRange
setOffset
in interface PositionedByteRange
setOffset
in class AbstractByteRange
offset
- the new start of this range.public PositionedByteRange setLength(int length)
offset + length
should not be greater than
bytes.length
. If position
is greater than the new length
, sets
position
to length
. n * The new length of this range.setLength
in interface ByteRange
setLength
in interface PositionedByteRange
setLength
in class AbstractByteRange
length
- The new length of this range.public int getPosition()
PositionedByteRange
position
marker. This valuae is 0-indexed, relative to the beginning of the
range.getPosition
in interface PositionedByteRange
public PositionedByteRange setPosition(int position)
PositionedByteRange
position
index. May not be greater than length
.setPosition
in interface PositionedByteRange
position
- the new position in this range.public int getRemaining()
PositionedByteRange
getRemaining
in interface PositionedByteRange
public byte peek()
PositionedByteRange
peek
in interface PositionedByteRange
public byte get()
PositionedByteRange
get
in interface PositionedByteRange
public PositionedByteRange get(byte[] dst)
PositionedByteRange
dst
with bytes from the range, starting from position
. This range's
position
is incremented by the length of dst
, the number of bytes copied.get
in interface PositionedByteRange
dst
- the destination of the copy.public PositionedByteRange get(byte[] dst, int offset, int length)
PositionedByteRange
dst
with bytes from the range, starting from the current position
.
length
bytes are copied into dst
, starting at offset
. This range's
position
is incremented by the number of bytes copied.get
in interface PositionedByteRange
dst
- the destination of the copy.offset
- the offset into dst
to start the copy.length
- the number of bytes to copy into dst
.public PositionedByteRange get(int index, byte[] dst)
ByteRange
dst
with bytes from the range, starting from index
.get
in interface ByteRange
get
in interface PositionedByteRange
get
in class AbstractByteRange
index
- zero-based index into this range.dst
- the destination of the copy.public PositionedByteRange get(int index, byte[] dst, int offset, int length)
ByteRange
dst
with bytes from the range, starting from index
. length
bytes
are copied into dst
, starting at offset
.get
in interface ByteRange
get
in interface PositionedByteRange
get
in class AbstractByteRange
index
- zero-based index into this range.dst
- the destination of the copy.offset
- the offset into dst
to start the copy.length
- the number of bytes to copy into dst
.public short getShort()
PositionedByteRange
getShort
in interface PositionedByteRange
public int getInt()
PositionedByteRange
getInt
in interface PositionedByteRange
public long getLong()
PositionedByteRange
getLong
in interface PositionedByteRange
public long getVLong()
PositionedByteRange
getVLong
in interface PositionedByteRange
public PositionedByteRange setLimit(int limit)
PositionedByteRange
setLimit
in interface PositionedByteRange
public int getLimit()
PositionedByteRange
getLimit
in interface PositionedByteRange
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.