net.named_data.jndn.util

Class DynamicByteBuffer

java.lang.Object

net.named_data.jndn.util.DynamicByteBuffer

public class DynamicByteBuffer
extends Object

A DynamicByteBuffer maintains a ByteBuffer and provides methods to ensure a minimum capacity, resizing if necessary.

Constructor Summary

Constructors

Constructor and Description
DynamicByteBuffer(int initialCapacity) Create a new DynamicByteBuffer with an initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	buffer() Return the ByteBuffer.
void	ensureCapacity(int capacity) Ensure that buffer().capacity() is greater than or equal to capacity.
void	ensureCapacityFromBack(int capacity) Ensure that buffer().capacity() is greater than or equal to capacity.
void	ensuredPut(byte b) Call ensureCapacity to ensure there is capacity for 1 more byte and call buffer().put(b).
void	ensuredPut(ByteBuffer buffer) Call ensureCapacity to ensure there is capacity for buffer.remaining() more bytes and use buffer().put to copy.
void	ensuredPut(ByteBuffer buffer, int position, int limit) Call ensureCapacity to ensure there is capacity for (limit - position) more bytes and use buffer().put to copy.
void	ensuredPutFromBack(byte b) Call setRemainingFromBack to ensure there are remaining bytes for 1 more byte and put b at the new position.
void	ensureRemainingCapacity(int remainingCapacity) Use ensureCapacity to ensure there are remainingCapacity bytes after position().
ByteBuffer	flippedBuffer() Return a new ByteBuffer which is the flipped version of buffer().
int	limit() Return buffer_.limit().
int	position() Return buffer_.position().
void	position(int newPosition) Call buffer_.position(newPosition).
int	remaining() Return buffer_.remaining().
int	setRemainingFromBack(int remaining) Change the position so that there are remaining bytes in the buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicByteBuffer

public DynamicByteBuffer(int initialCapacity)

Create a new DynamicByteBuffer with an initial capacity.

Parameters:

initialCapacity - The initial capacity of buffer().

Method Detail

ensureCapacity

public final void ensureCapacity(int capacity)

Ensure that buffer().capacity() is greater than or equal to capacity. If it is, just set the limit to the capacity. Otherwise, allocate a new buffer and copy everything from 0 to the position to the new buffer, set the same position and set the limit to the new capacity. Note that this does not copy the mark to the new buffer.

Parameters:

capacity - The minimum needed capacity.

ensureRemainingCapacity

public final void ensureRemainingCapacity(int remainingCapacity)

Use ensureCapacity to ensure there are remainingCapacity bytes after position().

Parameters:

remainingCapacity - The desired minimum capacity after position().

ensuredPut

public final void ensuredPut(byte b)

Call ensureCapacity to ensure there is capacity for 1 more byte and call buffer().put(b). This increments the position by 1.

Parameters:

b - The byte to put.

ensuredPut

public final void ensuredPut(ByteBuffer buffer)

Call ensureCapacity to ensure there is capacity for buffer.remaining() more bytes and use buffer().put to copy. This increments the position by buffer.remaining(). This does update buffer's position to its limit.

Parameters:

buffer - The buffer to copy from. This does not change buffer.position() or buffer.limit().

ensuredPut

public final void ensuredPut(ByteBuffer buffer,
              int position,
              int limit)

Call ensureCapacity to ensure there is capacity for (limit - position) more bytes and use buffer().put to copy. This increments the position by (limit - position).

Parameters:

buffer - The buffer to copy from. This does not change buffer.position() or buffer.limit().

position - The position in buffer to copy from.

limit - The limit in buffer to copy from.

ensureCapacityFromBack

public final void ensureCapacityFromBack(int capacity)

Ensure that buffer().capacity() is greater than or equal to capacity. If it is, just set the limit to the capacity. Otherwise, allocate a new buffer and copy everything from the position to the limit to the back of the new buffer, set the limit to the new capacity and set the position to keep the same number of remaining bytes. Note that this does not copy the mark to the new buffer.

Parameters:

capacity - The minimum needed capacity.

setRemainingFromBack

public final int setRemainingFromBack(int remaining)

Change the position so that there are remaining bytes in the buffer. If position would be negative, use ensureCapacityFromBack to expand the buffer.

Parameters:

remaining - The desired remaining bytes which causes the position to be changed.

Returns:

The new position.

ensuredPutFromBack

public final void ensuredPutFromBack(byte b)

Call setRemainingFromBack to ensure there are remaining bytes for 1 more byte and put b at the new position.

Parameters:

b - The byte to put.

buffer

public final ByteBuffer buffer()

Return the ByteBuffer. Note that ensureCapacity can change the returned ByteBuffer.

Returns:

The ByteBuffer.

flippedBuffer

public final ByteBuffer flippedBuffer()

Return a new ByteBuffer which is the flipped version of buffer(). The returned buffer's position is 0 and its limit is position().

Returns:

A new ByteBuffer

position

public final int position()

Return buffer_.position().

Returns:

The position.

position

public final void position(int newPosition)

Call buffer_.position(newPosition).

Parameters:

newPosition - The new position.

limit

public final int limit()

Return buffer_.limit().

Returns:

The limit.

remaining

public final int remaining()

Return buffer_.remaining().

Returns:

The number of remaining bytes.