Package org.jboss.netty.buffer

Class ReadOnlyChannelBuffer

java.lang.Object

org.jboss.netty.buffer.AbstractChannelBuffer

org.jboss.netty.buffer.ReadOnlyChannelBuffer

All Implemented Interfaces:

java.lang.Comparable<ChannelBuffer>, ChannelBuffer, WrappedChannelBuffer

public class ReadOnlyChannelBuffer
extends AbstractChannelBuffer
implements WrappedChannelBuffer

A derived buffer which forbids any write requests to its parent. It is recommended to use ChannelBuffers.unmodifiableBuffer(ChannelBuffer) instead of calling the constructor explicitly.

Field Summary

Fields

Modifier and Type	Field	Description
private ChannelBuffer	buffer

Constructor Summary

Constructors

Modifier	Constructor	Description
	ReadOnlyChannelBuffer(ChannelBuffer buffer)
private	ReadOnlyChannelBuffer(ReadOnlyChannelBuffer buffer)

Method Summary

Modifier and Type	Method	Description
byte[]	array()	Returns the backing byte array of this buffer.
int	arrayOffset()	Returns the offset of the first byte within the backing byte array of this buffer.
int	capacity()	Returns the number of bytes (octets) this buffer can contain.
ChannelBuffer	copy(int index, int length)	Returns a copy of this buffer's sub-region.
void	discardReadBytes()	Discards the bytes between the 0th index and readerIndex.
ChannelBuffer	duplicate()	Returns a buffer which shares the whole region of this buffer.
ChannelBufferFactory	factory()	Returns the factory which creates a ChannelBuffer whose type and default ByteOrder are same with this buffer.
byte	getByte(int index)	Gets a byte at the specified absolute index in this buffer.
void	getBytes(int index, byte[] dst, int dstIndex, int length)	Transfers this buffer's data to the specified destination starting at the specified absolute index.
void	getBytes(int index, java.io.OutputStream out, int length)	Transfers this buffer's data to the specified stream starting at the specified absolute index.
void	getBytes(int index, java.nio.ByteBuffer dst)	Transfers this buffer's data to the specified destination starting at the specified absolute index until the destination's position reaches its limit.
int	getBytes(int index, java.nio.channels.GatheringByteChannel out, int length)	Transfers this buffer's data to the specified channel starting at the specified absolute index.
void	getBytes(int index, ChannelBuffer dst, int dstIndex, int length)	Transfers this buffer's data to the specified destination starting at the specified absolute index.
int	getInt(int index)	Gets a 32-bit integer at the specified absolute index in this buffer.
long	getLong(int index)	Gets a 64-bit long integer at the specified absolute index in this buffer.
short	getShort(int index)	Gets a 16-bit short integer at the specified absolute index in this buffer.
int	getUnsignedMedium(int index)	Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer.
boolean	hasArray()	Returns true if and only if this buffer has a backing byte array.
boolean	isDirect()	Returns true if and only if this buffer is backed by an NIO direct buffer.
java.nio.ByteOrder	order()	Returns the endianness of this buffer.
void	setByte(int index, int value)	Sets the specified byte at the specified absolute index in this buffer.
void	setBytes(int index, byte[] src, int srcIndex, int length)	Transfers the specified source array's data to this buffer starting at the specified absolute index.
int	setBytes(int index, java.io.InputStream in, int length)	Transfers the content of the specified source stream to this buffer starting at the specified absolute index.
void	setBytes(int index, java.nio.ByteBuffer src)	Transfers the specified source buffer's data to this buffer starting at the specified absolute index until the source buffer's position reaches its limit.
int	setBytes(int index, java.nio.channels.ScatteringByteChannel in, int length)	Transfers the content of the specified source channel to this buffer starting at the specified absolute index.
void	setBytes(int index, ChannelBuffer src, int srcIndex, int length)	Transfers the specified source buffer's data to this buffer starting at the specified absolute index.
void	setInt(int index, int value)	Sets the specified 32-bit integer at the specified absolute index in this buffer.
void	setLong(int index, long value)	Sets the specified 64-bit long integer at the specified absolute index in this buffer.
void	setMedium(int index, int value)	Sets the specified 24-bit medium integer at the specified absolute index in this buffer.
void	setShort(int index, int value)	Sets the specified 16-bit short integer at the specified absolute index in this buffer.
ChannelBuffer	slice(int index, int length)	Returns a slice of this buffer's sub-region.
java.nio.ByteBuffer	toByteBuffer(int index, int length)	Converts this buffer's sub-region into a NIO buffer.
java.nio.ByteBuffer[]	toByteBuffers(int index, int length)	Converts this buffer's sub-region into an array of NIO buffers.
ChannelBuffer	unwrap()	Returns this buffer's parent that this buffer is wrapping.

Methods inherited from class org.jboss.netty.buffer.AbstractChannelBuffer

bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, ensureWritableBytes, equals, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, markReaderIndex, markWriterIndex, readable, readableBytes, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, slice, toByteBuffer, toByteBuffers, toString, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.netty.buffer.ChannelBuffer

bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, clear, compareTo, copy, ensureWritableBytes, equals, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, markReaderIndex, markWriterIndex, readable, readableBytes, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, slice, toByteBuffer, toByteBuffers, toString, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero

Field Detail

buffer

private final ChannelBuffer buffer

Constructor Detail

ReadOnlyChannelBuffer

public ReadOnlyChannelBuffer(ChannelBuffer buffer)

ReadOnlyChannelBuffer

private ReadOnlyChannelBuffer(ReadOnlyChannelBuffer buffer)

Method Detail

unwrap

public ChannelBuffer unwrap()

Description copied from interface: WrappedChannelBuffer

Returns this buffer's parent that this buffer is wrapping.

Specified by:

unwrap in interface WrappedChannelBuffer

factory

public ChannelBufferFactory factory()

Description copied from interface: ChannelBuffer

Returns the factory which creates a ChannelBuffer whose type and default ByteOrder are same with this buffer.

Specified by:

factory in interface ChannelBuffer

order

public java.nio.ByteOrder order()

Description copied from interface: ChannelBuffer

Returns the endianness of this buffer.

Specified by:

order in interface ChannelBuffer

isDirect

public boolean isDirect()

Description copied from interface: ChannelBuffer

Returns true if and only if this buffer is backed by an NIO direct buffer.

Specified by:

isDirect in interface ChannelBuffer

hasArray

public boolean hasArray()

Description copied from interface: ChannelBuffer

Returns true if and only if this buffer has a backing byte array. If this method returns true, you can safely call ChannelBuffer.array() and ChannelBuffer.arrayOffset().

Specified by:

hasArray in interface ChannelBuffer

array

public byte[] array()

Description copied from interface: ChannelBuffer

Returns the backing byte array of this buffer.

Specified by:

array in interface ChannelBuffer

arrayOffset

public int arrayOffset()

Description copied from interface: ChannelBuffer

Returns the offset of the first byte within the backing byte array of this buffer.

Specified by:

arrayOffset in interface ChannelBuffer

discardReadBytes

public void discardReadBytes()

Description copied from interface: ChannelBuffer

Discards the bytes between the 0th index and readerIndex. It moves the bytes between readerIndex and writerIndex to the 0th index, and sets readerIndex and writerIndex to 0 and oldWriterIndex - oldReaderIndex respectively.

Please refer to the class documentation for more detailed explanation.

Specified by:

discardReadBytes in interface ChannelBuffer

Overrides:

discardReadBytes in class AbstractChannelBuffer

setByte

public void setByte(int index,
                    int value)

Description copied from interface: ChannelBuffer

Sets the specified byte at the specified absolute index in this buffer. The 24 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setByte in interface ChannelBuffer

setBytes

public void setBytes(int index,
                     ChannelBuffer src,
                     int srcIndex,
                     int length)

Description copied from interface: ChannelBuffer

Transfers the specified source buffer's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.

Specified by:

setBytes in interface ChannelBuffer

srcIndex - the first index of the source

length - the number of bytes to transfer

setBytes

public void setBytes(int index,
                     byte[] src,
                     int srcIndex,
                     int length)

Description copied from interface: ChannelBuffer

Transfers the specified source array's data to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setBytes in interface ChannelBuffer

setBytes

public void setBytes(int index,
                     java.nio.ByteBuffer src)

Description copied from interface: ChannelBuffer

Transfers the specified source buffer's data to this buffer starting at the specified absolute index until the source buffer's position reaches its limit. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setBytes in interface ChannelBuffer

setShort

public void setShort(int index,
                     int value)

Description copied from interface: ChannelBuffer

Sets the specified 16-bit short integer at the specified absolute index in this buffer. The 16 high-order bits of the specified value are ignored. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setShort in interface ChannelBuffer

setMedium

public void setMedium(int index,
                      int value)

Description copied from interface: ChannelBuffer

Sets the specified 24-bit medium integer at the specified absolute index in this buffer. Please note that the most significant byte is ignored in the specified value. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setMedium in interface ChannelBuffer

setInt

public void setInt(int index,
                   int value)

Description copied from interface: ChannelBuffer

Sets the specified 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setInt in interface ChannelBuffer

setLong

public void setLong(int index,
                    long value)

Description copied from interface: ChannelBuffer

Sets the specified 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setLong in interface ChannelBuffer

setBytes

public int setBytes(int index,
                    java.io.InputStream in,
                    int length)
             throws java.io.IOException

Description copied from interface: ChannelBuffer

Transfers the content of the specified source stream to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setBytes in interface ChannelBuffer

length - the number of bytes to transfer

Returns:

the actual number of bytes read in from the specified channel. -1 if the specified channel is closed.

Throws:

java.io.IOException - if the specified stream threw an exception during I/O

setBytes

public int setBytes(int index,
                    java.nio.channels.ScatteringByteChannel in,
                    int length)
             throws java.io.IOException

Description copied from interface: ChannelBuffer

Transfers the content of the specified source channel to this buffer starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

setBytes in interface ChannelBuffer

length - the maximum number of bytes to transfer

Returns:

the actual number of bytes read in from the specified channel. -1 if the specified channel is closed.

Throws:

java.io.IOException - if the specified channel threw an exception during I/O

getBytes

public int getBytes(int index,
                    java.nio.channels.GatheringByteChannel out,
                    int length)
             throws java.io.IOException

Description copied from interface: ChannelBuffer

Transfers this buffer's data to the specified channel starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getBytes in interface ChannelBuffer

length - the maximum number of bytes to transfer

Returns:

the actual number of bytes written out to the specified channel

Throws:

java.io.IOException - if the specified channel threw an exception during I/O

getBytes

public void getBytes(int index,
                     java.io.OutputStream out,
                     int length)
              throws java.io.IOException

Description copied from interface: ChannelBuffer

Transfers this buffer's data to the specified stream starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getBytes in interface ChannelBuffer

length - the number of bytes to transfer

Throws:

java.io.IOException - if the specified stream threw an exception during I/O

getBytes

public void getBytes(int index,
                     byte[] dst,
                     int dstIndex,
                     int length)

Description copied from interface: ChannelBuffer

Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getBytes in interface ChannelBuffer

dstIndex - the first index of the destination

length - the number of bytes to transfer

getBytes

public void getBytes(int index,
                     ChannelBuffer dst,
                     int dstIndex,
                     int length)

Description copied from interface: ChannelBuffer

Transfers this buffer's data to the specified destination starting at the specified absolute index. This method does not modify readerIndex or writerIndex of both the source (i.e. this) and the destination.

Specified by:

getBytes in interface ChannelBuffer

dstIndex - the first index of the destination

length - the number of bytes to transfer

getBytes

public void getBytes(int index,
                     java.nio.ByteBuffer dst)

Description copied from interface: ChannelBuffer

Transfers this buffer's data to the specified destination starting at the specified absolute index until the destination's position reaches its limit. This method does not modify readerIndex or writerIndex of this buffer while the destination's position will be increased.

Specified by:

getBytes in interface ChannelBuffer

duplicate

public ChannelBuffer duplicate()

Description copied from interface: ChannelBuffer

Returns a buffer which shares the whole region of this buffer. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method is identical to buf.slice(0, buf.capacity()). This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

duplicate in interface ChannelBuffer

copy

public ChannelBuffer copy(int index,
                          int length)

Description copied from interface: ChannelBuffer

Returns a copy of this buffer's sub-region. Modifying the content of the returned buffer or this buffer does not affect each other at all. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

copy in interface ChannelBuffer

slice

public ChannelBuffer slice(int index,
                           int length)

Description copied from interface: ChannelBuffer

Returns a slice of this buffer's sub-region. Modifying the content of the returned buffer or this buffer affects each other's content while they maintain separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

slice in interface ChannelBuffer

getByte

public byte getByte(int index)

Description copied from interface: ChannelBuffer

Gets a byte at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getByte in interface ChannelBuffer

getShort

public short getShort(int index)

Description copied from interface: ChannelBuffer

Gets a 16-bit short integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getShort in interface ChannelBuffer

getUnsignedMedium

public int getUnsignedMedium(int index)

Description copied from interface: ChannelBuffer

Gets an unsigned 24-bit medium integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getUnsignedMedium in interface ChannelBuffer

getInt

public int getInt(int index)

Description copied from interface: ChannelBuffer

Gets a 32-bit integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getInt in interface ChannelBuffer

getLong

public long getLong(int index)

Description copied from interface: ChannelBuffer

Gets a 64-bit long integer at the specified absolute index in this buffer. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

getLong in interface ChannelBuffer

toByteBuffer

public java.nio.ByteBuffer toByteBuffer(int index,
                                        int length)

Description copied from interface: ChannelBuffer

Converts this buffer's sub-region into a NIO buffer. The returned buffer might or might not share the content with this buffer, while they have separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

toByteBuffer in interface ChannelBuffer

toByteBuffers

public java.nio.ByteBuffer[] toByteBuffers(int index,
                                           int length)

Description copied from interface: ChannelBuffer

Converts this buffer's sub-region into an array of NIO buffers. The returned buffers might or might not share the content with this buffer, while they have separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.

Specified by:

toByteBuffers in interface ChannelBuffer

Overrides:

toByteBuffers in class AbstractChannelBuffer

capacity

public int capacity()

Description copied from interface: ChannelBuffer

Returns the number of bytes (octets) this buffer can contain.

Specified by:

capacity in interface ChannelBuffer