org.apache.datasketches.memory

Interface BaseBuffer

All Superinterfaces:

BaseState

All Known Subinterfaces:

Buffer, WritableBuffer

public interface BaseBuffer
extends BaseState

Defines the relative positional API.

Author:

Lee Rhodes

Field Summary

Fields inherited from interface org.apache.datasketches.memory.BaseState

defaultMemReqSvr

Method Summary

Modifier and Type	Method and Description
long	getEnd() Gets the end position
long	getPosition() Gets the current position
long	getRemaining() The number of elements remaining between the current position and the end position
long	getStart() Gets start position
boolean	hasRemaining() Returns true if there are elements remaining between the current position and the end position
BaseBuffer	incrementAndCheckPosition(long increment) Increments the current position by the given increment.
BaseBuffer	incrementPosition(long increment) Increments the current position by the given increment.
BaseBuffer	resetPosition() Resets the current position to the start position, This does not modify any data.
BaseBuffer	setAndCheckPosition(long position) Sets the current position.
BaseBuffer	setAndCheckStartPositionEnd(long start, long position, long end) Sets start position, current position, and end position.
BaseBuffer	setPosition(long position) Sets the current position.
BaseBuffer	setStartPositionEnd(long start, long position, long end) Sets start position, current position, and end position.

Methods inherited from interface org.apache.datasketches.memory.BaseState

checkValidAndBounds, equals, equalTo, getByteBuffer, getCapacity, getCumulativeOffset, getCumulativeOffset, getCurrentDirectMemoryAllocated, getCurrentDirectMemoryAllocations, getCurrentDirectMemoryMapAllocated, getCurrentDirectMemoryMapAllocations, getRegionOffset, getRegionOffset, getTypeByteOrder, hasArray, hasByteBuffer, hashCode, isByteOrderCompatible, isDirect, isReadOnly, isSameResource, isValid, toHexString, xxHash64, xxHash64

Method Detail

incrementPosition

BaseBuffer incrementPosition(long increment)

Increments the current position by the given increment. Asserts that the resource is valid and that the positional invariants are not violated, otherwise, if asserts are enabled throws an AssertionError.

Parameters:

increment - the given increment

Returns:

BaseBuffer

incrementAndCheckPosition

BaseBuffer incrementAndCheckPosition(long increment)

Increments the current position by the given increment. Checks that the resource is valid and that the positional invariants are not violated, otherwise throws an IllegalArgumentException.

Parameters:

increment - the given increment

Returns:

BaseBuffer

getEnd

long getEnd()

Gets the end position

Returns:

the end position

getPosition

long getPosition()

Gets the current position

Returns:

the current position

getStart

long getStart()

Gets start position

Returns:

start position

getRemaining

long getRemaining()

The number of elements remaining between the current position and the end position

Returns:

(end - position)

hasRemaining

boolean hasRemaining()

Returns true if there are elements remaining between the current position and the end position

Returns:

(end - position) > 0

resetPosition

BaseBuffer resetPosition()

Resets the current position to the start position, This does not modify any data.

Returns:

BaseBuffer

setPosition

BaseBuffer setPosition(long position)

Sets the current position. Asserts that the positional invariants are not violated, otherwise, if asserts are enabled throws an AssertionError.

Parameters:

position - the given current position.

Returns:

BaseBuffer

setAndCheckPosition

BaseBuffer setAndCheckPosition(long position)

Sets the current position. Checks that the positional invariants are not violated, otherwise, throws an IllegalArgumentException.

Parameters:

position - the given current position.

Returns:

BaseBuffer

setStartPositionEnd

BaseBuffer setStartPositionEnd(long start,
                               long position,
                               long end)

Sets start position, current position, and end position. Asserts that the positional invariants are not violated, otherwise, if asserts are enabled throws an AssertionError.

Parameters:

start - the start position in the buffer

position - the current position between the start and end

end - the end position in the buffer

Returns:

BaseBuffer

setAndCheckStartPositionEnd

BaseBuffer setAndCheckStartPositionEnd(long start,
                                       long position,
                                       long end)

Sets start position, current position, and end position. Checks that the positional invariants are not violated, otherwise, throws an IllegalArgumentException.

Parameters:

start - the start position in the buffer

position - the current position between the start and end

end - the end position in the buffer

Returns:

BaseBuffer