Module org.eclipse.jetty.io

Package org.eclipse.jetty.io

Class RetainableByteBuffer.FixedCapacity

java.lang.Object

org.eclipse.jetty.io.Retainable.Wrapper

org.eclipse.jetty.io.RetainableByteBuffer.Abstract

org.eclipse.jetty.io.RetainableByteBuffer.FixedCapacity

All Implemented Interfaces:

Retainable, RetainableByteBuffer, RetainableByteBuffer.Mutable

Direct Known Subclasses:

AbstractRetainableByteBuffer, ArrayByteBufferPool.Tracking.TrackedBuffer, RetainableByteBuffer.NonRetainableByteBuffer, RetainableByteBuffer.Pooled

Enclosing interface:

RetainableByteBuffer

public static class RetainableByteBuffer.FixedCapacity
extends RetainableByteBuffer.Abstract
implements RetainableByteBuffer.Mutable

A fixed capacity RetainableByteBuffer.Mutable RetainableByteBuffer backed by a single ByteBuffer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Retainable

Retainable.ReferenceCounter, Retainable.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

RetainableByteBuffer.Abstract, RetainableByteBuffer.DynamicCapacity, RetainableByteBuffer.EmptyRetainableByteBuffer, RetainableByteBuffer.FixedCapacity, RetainableByteBuffer.Mutable, RetainableByteBuffer.NonRetainableByteBuffer, RetainableByteBuffer.Pooled, RetainableByteBuffer.Wrapper

Field Summary

Fields inherited from interface org.eclipse.jetty.io.Retainable

NON_RETAINABLE

Fields inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

EMPTY

Constructor Summary

Constructors

Constructor	Description
FixedCapacity(ByteBuffer byteBuffer)
FixedCapacity(ByteBuffer byteBuffer, Retainable retainable)

Method Summary

Modifier and Type	Method	Description
RetainableByteBuffer.Mutable	add(ByteBuffer bytes)	Add the passed ByteBuffer to this buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	add(RetainableByteBuffer bytes)	Add the passed RetainableByteBuffer to this buffer, growing this buffer if necessary and possible.
protected void	addValueMarker(StringBuilder builder, boolean beginning)
boolean	append(ByteBuffer bytes)	Copies the contents of the given byte buffer to the end of this buffer, growing this buffer if necessary and possible.
boolean	append(RetainableByteBuffer bytes)	Retain or copy the contents of the given retainable byte buffer to the end of this buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	asMutable()	Access this buffer via the RetainableByteBuffer.Mutable API.
int	capacity()
void	clear()
byte	get(long index)	Returns a byte from this RetainableByteBuffer at a specific index
ByteBuffer	getByteBuffer()	Get the wrapped, not null, ByteBuffer.
boolean	hasRemaining()
boolean	isDirect()
void	limit(long size)	Limit this buffer's contents to the size.
RetainableByteBuffer.Mutable	put(byte b)	Put a byte to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	put(byte[] bytes, int offset, int length)	Put a byte array to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	put(long index, byte b)	Put a byte to the buffer at a given index.
RetainableByteBuffer.Mutable	putInt(int i)	Put an int to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	putLong(long l)	Put a long to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	putShort(short s)	Put a short to the buffer, growing this buffer if necessary and possible.
int	remaining()
long	space()

Methods inherited from class org.eclipse.jetty.io.RetainableByteBuffer.Abstract

addExtraStringInfo, addStringInfo, addValueString, toDetailString, toString

Methods inherited from class org.eclipse.jetty.io.Retainable.Wrapper

canRetain, getRetained, getWrapped, isRetained, release, retain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.io.Retainable

canRetain, getRetained, isRetained, release, retain

Methods inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

appendTo, appendTo, copy, get, get, isEmpty, isFull, isMutable, maxSize, putTo, size, skip, slice, slice, take, take, takeByteArray, takeFrom, toDetailString, writeTo, writeTo

Methods inherited from interface org.eclipse.jetty.io.RetainableByteBuffer.Mutable

put

Constructor Details

FixedCapacity

public FixedCapacity(ByteBuffer byteBuffer)

FixedCapacity

public FixedCapacity(ByteBuffer byteBuffer,
 Retainable retainable)

Method Details

clear

public void clear()

Specified by:

clear in interface RetainableByteBuffer

See Also:

• BufferUtil.clear(ByteBuffer)

space

public long space()

Specified by:

space in interface RetainableByteBuffer

Returns:

the number of bytes that can be added, appended or put into this buffer, assuming it is mutable.

asMutable

public RetainableByteBuffer.Mutable asMutable()

Description copied from interface: RetainableByteBuffer

Access this buffer via the RetainableByteBuffer.Mutable API. Note that the RetainableByteBuffer.Mutable API may be backed by an immutable ByteBuffer.

Specified by:

asMutable in interface RetainableByteBuffer

Returns:

An RetainableByteBuffer.Mutable representation of this buffer with same data and pointers.

See Also:

• RetainableByteBuffer.isMutable()

remaining

public int remaining()

Specified by:

remaining in interface RetainableByteBuffer

Returns:

the number of remaining bytes in the ByteBuffer

See Also:

• RetainableByteBuffer.size()

hasRemaining

public boolean hasRemaining()

Specified by:

hasRemaining in interface RetainableByteBuffer

Returns:

whether the ByteBuffer has remaining bytes

isDirect

public boolean isDirect()

Specified by:

isDirect in interface RetainableByteBuffer

Returns:

whether the ByteBuffer is direct

capacity

public int capacity()

Specified by:

capacity in interface RetainableByteBuffer

Returns:

the capacity

See Also:

• RetainableByteBuffer.maxSize()

get

public byte get(long index)
         throws IndexOutOfBoundsException

Description copied from interface: RetainableByteBuffer

Returns a byte from this RetainableByteBuffer at a specific index

Specified by:

get in interface RetainableByteBuffer

Parameters:

index - The index relative to the current start of unconsumed data in the buffer.

Returns:

the byte

Throws:

IndexOutOfBoundsException - if the index is too large.

limit

public void limit(long size)

Description copied from interface: RetainableByteBuffer

Limit this buffer's contents to the size.

Specified by:

limit in interface RetainableByteBuffer

Parameters:

size - the new size of the buffer

getByteBuffer

public ByteBuffer getByteBuffer()

Description copied from interface: RetainableByteBuffer

Get the wrapped, not null, ByteBuffer.

If the implementation contains multiple buffers, they are coalesced to a single buffer before being returned. If the content is too large for a single ByteBuffer, then the content should be access with RetainableByteBuffer.writeTo(Content.Sink, boolean).

Specified by:

getByteBuffer in interface RetainableByteBuffer

Returns:

the wrapped, not null, ByteBuffer

append

public boolean append(ByteBuffer bytes)
               throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

Copies the contents of the given byte buffer to the end of this buffer, growing this buffer if necessary and possible.

Specified by:

append in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the byte buffer to copy from, which is consumed.

Returns:

true if all bytes of the given buffer were copied, false otherwise.

Throws:

ReadOnlyBufferException - if this buffer is read only.

See Also:

• RetainableByteBuffer.Mutable.add(ByteBuffer)

append

public boolean append(RetainableByteBuffer bytes)
               throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

Retain or copy the contents of the given retainable byte buffer to the end of this buffer, growing this buffer if necessary and possible. The implementation will heuristically decide to retain or copy the contents Unlike the similar RetainableByteBuffer.Mutable.add(RetainableByteBuffer), implementations of this method must Retainable.retain() the passed buffer if they keep a reference to it.

Specified by:

append in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the retainable byte buffer to copy from, which is consumed.

Returns:

true if all bytes of the given buffer were copied, false otherwise.

Throws:

ReadOnlyBufferException - if this buffer is read only.

See Also:

• RetainableByteBuffer.Mutable.add(RetainableByteBuffer)

add

public RetainableByteBuffer.Mutable add(ByteBuffer bytes)
                                 throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

Add the passed ByteBuffer to this buffer, growing this buffer if necessary and possible. The source ByteBuffer is passed by reference and the caller gives up "ownership", so implementations of this method may choose to avoid copies by keeping a reference to the buffer.

Specified by:

add in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the byte buffer to add, which is passed by reference and is not necessarily consumed by the add.

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

See Also:

• RetainableByteBuffer.Mutable.append(ByteBuffer)

add

public RetainableByteBuffer.Mutable add(RetainableByteBuffer bytes)
                                 throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

Add the passed RetainableByteBuffer to this buffer, growing this buffer if necessary and possible. The source RetainableByteBuffer is passed by reference and the caller gives up ownership, so implementations of this method may avoid copies by keeping a reference to the buffer. Unlike the similar RetainableByteBuffer.Mutable.append(RetainableByteBuffer) and contrary to the general rules of Retainable, implementations of this method need not call Retainable.retain() if keeping a reference, but they must ultimately call Retainable.release() the passed buffer. Callers should use add rather than RetainableByteBuffer.Mutable.append(RetainableByteBuffer) if they already have an obligation to release the buffer and wish to delegate that obligation to this buffer.

Specified by:

add in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the byte buffer to add, which is passed by reference and is not necessarily consumed by the add.

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

put

public RetainableByteBuffer.Mutable put(byte b)

Put a byte to the buffer, growing this buffer if necessary and possible.

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

b - the byte to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

put

public RetainableByteBuffer.Mutable put(long index,
 byte b)

Description copied from interface: RetainableByteBuffer.Mutable

Put a byte to the buffer at a given index.

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

index - The index relative to the current start of unconsumed data in the buffer.

b - the byte to put

Returns:

this buffer.

putShort

public RetainableByteBuffer.Mutable putShort(short s)

Put a short to the buffer, growing this buffer if necessary and possible.

Specified by:

putShort in interface RetainableByteBuffer.Mutable

Parameters:

s - the short to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

putInt

public RetainableByteBuffer.Mutable putInt(int i)

Put an int to the buffer, growing this buffer if necessary and possible.

Specified by:

putInt in interface RetainableByteBuffer.Mutable

Parameters:

i - the int to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

putLong

public RetainableByteBuffer.Mutable putLong(long l)

Put a long to the buffer, growing this buffer if necessary and possible.

Specified by:

putLong in interface RetainableByteBuffer.Mutable

Parameters:

l - the long to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

put

public RetainableByteBuffer.Mutable put(byte[] bytes,
 int offset,
 int length)

Put a byte array to the buffer, growing this buffer if necessary and possible.

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the byte array to put

offset - the offset into the array

length - the length in bytes to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

addValueMarker

protected void addValueMarker(StringBuilder builder,
 boolean beginning)

Overrides:

addValueMarker in class RetainableByteBuffer.Abstract