EmptyChannelBuffer (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.buffer.AbstractChannelBuffer
- - org.jboss.netty.buffer.HeapChannelBuffer
  - - org.jboss.netty.buffer.BigEndianHeapChannelBuffer
    - - org.jboss.netty.buffer.EmptyChannelBuffer

所有已实现的接口:

java.lang.Comparable<ChannelBuffer>, ChannelBuffer
```
public class EmptyChannelBuffer
extends BigEndianHeapChannelBuffer
```
An immutable empty buffer implementation. Typically used as a singleton via ChannelBuffers.EMPTY_BUFFER and returned by ChannelBuffers.buffer(int) etc when an empty buffer is requested.
Note: For backwards compatibility, this class extends BigEndianHeapChannelBuffer. However, it never makes any writes to the reader and writer indices, which avoids contention when the singleton instance is used concurrently.

字段概要
- 从类继承的字段 org.jboss.netty.buffer.HeapChannelBuffer
  array

方法概要

方法
限定符和类型	方法和说明
`protected void`	`checkReadableBytes(int length)` Throws an `IndexOutOfBoundsException` the length is not 0.
`void`	`clear()` Sets the `readerIndex` and `writerIndex` of this buffer to `0`.
`void`	`discardReadBytes()` Discards the bytes between the 0th index and `readerIndex`.
`void`	`markReaderIndex()` Marks the current `readerIndex` in this buffer.
`void`	`markWriterIndex()` Marks the current `writerIndex` in this buffer.
`void`	`readBytes(byte[] dst)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `dst.length`).
`void`	`readBytes(byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`void`	`readBytes(java.nio.ByteBuffer dst)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` until the destination's position reaches its limit, and increases the `readerIndex` by the number of the transferred bytes.
`void`	`readBytes(ChannelBuffer dst)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` until the destination becomes non-writable, and increases the `readerIndex` by the number of the transferred bytes.
`void`	`readBytes(ChannelBuffer dst, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`void`	`readBytes(ChannelBuffer dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`int`	`readBytes(java.nio.channels.GatheringByteChannel out, int length)` Transfers this buffer's data to the specified stream starting at the current `readerIndex`.
`ChannelBuffer`	`readBytes(int length)` Transfers this buffer's data to a newly created buffer starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`void`	`readBytes(java.io.OutputStream out, int length)` Transfers this buffer's data to the specified stream starting at the current `readerIndex`.
`void`	`readerIndex(int readerIndex)` Sets the `readerIndex` of this buffer.
`ChannelBuffer`	`readSlice(int length)` Returns a new slice of this buffer's sub-region starting at the current `readerIndex` and increases the `readerIndex` by the size of the new slice (= `length`).
`void`	`resetReaderIndex()` Repositions the current `readerIndex` to the marked `readerIndex` in this buffer.
`void`	`resetWriterIndex()` Repositions the current `writerIndex` to the marked `writerIndex` in this buffer.
`void`	`setIndex(int readerIndex, int writerIndex)` Sets the `readerIndex` and `writerIndex` of this buffer in one shot.
`void`	`skipBytes(int length)` Increases the current `readerIndex` by the specified `length` in this buffer.
`void`	`writeBytes(byte[] src, int srcIndex, int length)` Transfers the specified source array's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `length`).
`void`	`writeBytes(java.nio.ByteBuffer src)` Transfers the specified source buffer's data to this buffer starting at the current `writerIndex` until the source buffer's position reaches its limit, and increases the `writerIndex` by the number of the transferred bytes.
`void`	`writeBytes(ChannelBuffer src, int length)` Transfers the specified source buffer's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `length`).
`void`	`writeBytes(ChannelBuffer src, int srcIndex, int length)` Transfers the specified source buffer's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `length`).
`int`	`writeBytes(java.io.InputStream in, int length)` Transfers the content of the specified stream to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes.
`int`	`writeBytes(java.nio.channels.ScatteringByteChannel in, int length)` Transfers the content of the specified channel to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes.
`void`	`writerIndex(int writerIndex)` Sets the `writerIndex` of this buffer.
`void`	`writeZero(int length)` Fills this buffer with `NUL (0x00)` starting at the current `writerIndex` and increases the `writerIndex` by the specified `length`.

从类继承的方法 org.jboss.netty.buffer.BigEndianHeapChannelBuffer
copy, duplicate, factory, getInt, getLong, getShort, getUnsignedMedium, order, setInt, setLong, setMedium, setShort

从类继承的方法 org.jboss.netty.buffer.HeapChannelBuffer
array, arrayOffset, capacity, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, hasArray, isDirect, setByte, setBytes, setBytes, setBytes, setBytes, setBytes, slice, toByteBuffer

从类继承的方法 org.jboss.netty.buffer.AbstractChannelBuffer
bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, compareTo, copy, ensureWritableBytes, equals, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, readable, readableBytes, readByte, readChar, readDouble, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setZero, slice, toByteBuffer, toByteBuffers, toByteBuffers, toString, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writeShort

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - clear
```
public void clear()
```
    从接口复制的说明: ChannelBuffer
    
    Sets the readerIndex and writerIndex of this buffer to 0. This method is identical to setIndex(0, 0).
    Please note that the behavior of this method is different from that of NIO buffer, which sets the limit to the capacity of the buffer.
    
    指定者:
    
    clear 在接口中 ChannelBuffer
    
    覆盖:
    
    clear 在类中 AbstractChannelBuffer
  - readerIndex
```
public void readerIndex(int readerIndex)
```
    从接口复制的说明: ChannelBuffer
    
    Sets the readerIndex of this buffer.
    
    指定者:
    
    readerIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    readerIndex 在类中 AbstractChannelBuffer
  - writerIndex
```
public void writerIndex(int writerIndex)
```
    从接口复制的说明: ChannelBuffer
    
    Sets the writerIndex of this buffer.
    
    指定者:
    
    writerIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    writerIndex 在类中 AbstractChannelBuffer
  - setIndex
```
public void setIndex(int readerIndex,
            int writerIndex)
```
    从接口复制的说明: ChannelBuffer
    Sets the readerIndex and writerIndex of this buffer in one shot. This method is useful when you have to worry about the invocation order of ChannelBuffer.readerIndex(int) and ChannelBuffer.writerIndex(int) methods. For example, the following code will fail:
```
 // Create a buffer whose readerIndex, writerIndex and capacity are
 // 0, 0 and 8 respectively.
 ChannelBuffer buf = ChannelBuffers.buffer(8);

 // IndexOutOfBoundsException is thrown because the specified
 // readerIndex (2) cannot be greater than the current writerIndex (0).
 buf.readerIndex(2);
 buf.writerIndex(4);
 
```
    The following code will also fail:
```
 // Create a buffer whose readerIndex, writerIndex and capacity are
 // 0, 8 and 8 respectively.
 ChannelBuffer buf = ChannelBuffers.wrappedBuffer(new byte[8]);

 // readerIndex becomes 8.
 buf.readLong();

 // IndexOutOfBoundsException is thrown because the specified
 // writerIndex (4) cannot be less than the current readerIndex (8).
 buf.writerIndex(4);
 buf.readerIndex(2);
 
```
    By contrast, this method guarantees that it never throws an IndexOutOfBoundsException as long as the specified indexes meet basic constraints, regardless what the current index values of the buffer are:
```
 // No matter what the current state of the buffer is, the following
 // call always succeeds as long as the capacity of the buffer is not
 // less than 4.
 buf.setIndex(2, 4);
 
```
    指定者:
    
    setIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    setIndex 在类中 AbstractChannelBuffer
  - markReaderIndex
```
public void markReaderIndex()
```
    从接口复制的说明: ChannelBuffer
    
    Marks the current readerIndex in this buffer. You can reposition the current readerIndex to the marked readerIndex by calling ChannelBuffer.resetReaderIndex(). The initial value of the marked readerIndex is 0.
    
    指定者:
    
    markReaderIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    markReaderIndex 在类中 AbstractChannelBuffer
  - resetReaderIndex
```
public void resetReaderIndex()
```
    从接口复制的说明: ChannelBuffer
    
    Repositions the current readerIndex to the marked readerIndex in this buffer.
    
    指定者:
    
    resetReaderIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    resetReaderIndex 在类中 AbstractChannelBuffer
  - markWriterIndex
```
public void markWriterIndex()
```
    从接口复制的说明: ChannelBuffer
    
    Marks the current writerIndex in this buffer. You can reposition the current writerIndex to the marked writerIndex by calling ChannelBuffer.resetWriterIndex(). The initial value of the marked writerIndex is 0.
    
    指定者:
    
    markWriterIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    markWriterIndex 在类中 AbstractChannelBuffer
  - resetWriterIndex
```
public void resetWriterIndex()
```
    从接口复制的说明: ChannelBuffer
    
    Repositions the current writerIndex to the marked writerIndex in this buffer.
    
    指定者:
    
    resetWriterIndex 在接口中 ChannelBuffer
    
    覆盖:
    
    resetWriterIndex 在类中 AbstractChannelBuffer
  - discardReadBytes
```
public void discardReadBytes()
```
    从接口复制的说明: 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.
    
    指定者:
    
    discardReadBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    discardReadBytes 在类中 AbstractChannelBuffer
  - readBytes
```
public ChannelBuffer readBytes(int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to a newly created buffer starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length). The returned buffer's readerIndex and writerIndex are 0 and length respectively.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
    
    参数:
    length - the number of bytes to transfer
    
    返回:
    the newly created buffer which contains the transferred bytes
  - readSlice
```
public ChannelBuffer readSlice(int length)
```
    从接口复制的说明: ChannelBuffer
    
    Returns a new slice of this buffer's sub-region starting at the current readerIndex and increases the readerIndex by the size of the new slice (= length).
    
    指定者:
    
    readSlice 在接口中 ChannelBuffer
    
    覆盖:
    
    readSlice 在类中 AbstractChannelBuffer
    
    参数:
    length - the size of the new slice
    
    返回:
    the newly created slice
  - readBytes
```
public void readBytes(byte[] dst,
             int dstIndex,
             int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - readBytes
```
public void readBytes(byte[] dst)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= dst.length).
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
  - readBytes
```
public void readBytes(ChannelBuffer dst)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex until the destination becomes non-writable, and increases the readerIndex by the number of the transferred bytes. This method is basically same with ChannelBuffer.readBytes(ChannelBuffer, int, int), except that this method increases the writerIndex of the destination by the number of the transferred bytes while ChannelBuffer.readBytes(ChannelBuffer, int, int) does not.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
  - readBytes
```
public void readBytes(ChannelBuffer dst,
             int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length). This method is basically same with ChannelBuffer.readBytes(ChannelBuffer, int, int), except that this method increases the writerIndex of the destination by the number of the transferred bytes (= length) while ChannelBuffer.readBytes(ChannelBuffer, int, int) does not.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
  - readBytes
```
public void readBytes(ChannelBuffer dst,
             int dstIndex,
             int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - readBytes
```
public void readBytes(java.nio.ByteBuffer dst)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex until the destination's position reaches its limit, and increases the readerIndex by the number of the transferred bytes.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
  - readBytes
```
public int readBytes(java.nio.channels.GatheringByteChannel out,
            int length)
              throws java.io.IOException
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified stream starting at the current readerIndex.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
    
    length - the maximum number of bytes to transfer
    
    返回:
    the actual number of bytes written out to the specified channel
    
    抛出:
    
    java.io.IOException - if the specified channel threw an exception during I/O
  - readBytes
```
public void readBytes(java.io.OutputStream out,
             int length)
               throws java.io.IOException
```
    从接口复制的说明: ChannelBuffer
    
    Transfers this buffer's data to the specified stream starting at the current readerIndex.
    
    指定者:
    
    readBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    readBytes 在类中 AbstractChannelBuffer
    
    length - the number of bytes to transfer
    
    抛出:
    
    java.io.IOException - if the specified stream threw an exception during I/O
  - skipBytes
```
public void skipBytes(int length)
```
    从接口复制的说明: ChannelBuffer
    
    Increases the current readerIndex by the specified length in this buffer.
    
    指定者:
    
    skipBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    skipBytes 在类中 AbstractChannelBuffer
  - writeBytes
```
public void writeBytes(byte[] src,
              int srcIndex,
              int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
    
    srcIndex - the first index of the source
    length - the number of bytes to transfer
  - writeBytes
```
public void writeBytes(ChannelBuffer src,
              int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length). This method is basically same with ChannelBuffer.writeBytes(ChannelBuffer, int, int), except that this method increases the readerIndex of the source buffer by the number of the transferred bytes (= length) while ChannelBuffer.writeBytes(ChannelBuffer, int, int) does not.
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
    
    length - the number of bytes to transfer
  - writeBytes
```
public void writeBytes(ChannelBuffer src,
              int srcIndex,
              int length)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
    
    srcIndex - the first index of the source
    length - the number of bytes to transfer
  - writeBytes
```
public void writeBytes(java.nio.ByteBuffer src)
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the specified source buffer's data to this buffer starting at the current writerIndex until the source buffer's position reaches its limit, and increases the writerIndex by the number of the transferred bytes.
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
  - writeBytes
```
public int writeBytes(java.io.InputStream in,
             int length)
               throws java.io.IOException
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the content of the specified stream to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes.
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
    
    length - the number of bytes to transfer
    
    返回:
    the actual number of bytes read in from the specified stream
    
    抛出:
    
    java.io.IOException - if the specified stream threw an exception during I/O
  - writeBytes
```
public int writeBytes(java.nio.channels.ScatteringByteChannel in,
             int length)
               throws java.io.IOException
```
    从接口复制的说明: ChannelBuffer
    
    Transfers the content of the specified channel to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes.
    
    指定者:
    
    writeBytes 在接口中 ChannelBuffer
    
    覆盖:
    
    writeBytes 在类中 AbstractChannelBuffer
    
    length - the maximum number of bytes to transfer
    
    返回:
    the actual number of bytes read in from the specified channel
    
    抛出:
    
    java.io.IOException - if the specified channel threw an exception during I/O
  - writeZero
```
public void writeZero(int length)
```
    从接口复制的说明: ChannelBuffer
    
    Fills this buffer with NUL (0x00) starting at the current writerIndex and increases the writerIndex by the specified length.
    
    指定者:
    
    writeZero 在接口中 ChannelBuffer
    
    覆盖:
    
    writeZero 在类中 AbstractChannelBuffer
    
    参数:
    length - the number of NULs to write to the buffer
  - checkReadableBytes
```
protected void checkReadableBytes(int length)
```
    Throws an IndexOutOfBoundsException the length is not 0.
    
    覆盖:
    
    checkReadableBytes 在类中 AbstractChannelBuffer

类 EmptyChannelBuffer

字段概要

从类继承的字段 org.jboss.netty.buffer.HeapChannelBuffer

方法概要

从类继承的方法 org.jboss.netty.buffer.BigEndianHeapChannelBuffer

从类继承的方法 org.jboss.netty.buffer.HeapChannelBuffer

从类继承的方法 org.jboss.netty.buffer.AbstractChannelBuffer

从类继承的方法 java.lang.Object

方法详细资料

clear

readerIndex

writerIndex

setIndex

markReaderIndex

resetReaderIndex

markWriterIndex

resetWriterIndex

discardReadBytes

readBytes

readSlice

readBytes

readBytes

readBytes

readBytes

readBytes

readBytes

readBytes

readBytes

skipBytes

writeBytes

writeBytes

writeBytes

writeBytes

writeBytes

writeBytes

writeZero

checkReadableBytes