CompositeByteArray (MINA 2.0.13 API文档 - 即时通讯网(52im.net))

java.lang.Object
- org.apache.mina.util.byteaccess.CompositeByteArray

所有已实现的接口:

ByteArray, IoAbsoluteReader, IoAbsoluteWriter
```
public final class CompositeByteArray
extends java.lang.Object
```
A ByteArray composed of other ByteArrays. Optimised for fast relative access via cursors. Absolute access methods are provided, but may perform poorly. TODO: Write about laziness of cursor implementation - how movement doesn't happen until actual get/put.

作者:

Apache MINA Project

嵌套类概要

嵌套类
限定符和类型类和说明

static interface CompositeByteArray.CursorListener
Allows for efficient detection of component boundaries when using a cursor.
- 从接口继承的嵌套类/接口 org.apache.mina.util.byteaccess.ByteArray
  ByteArray.Cursor

嵌套类
限定符和类型	类和说明
`static interface`	`CompositeByteArray.CursorListener` Allows for efficient detection of component boundaries when using a cursor.

构造器概要

构造器
构造器和说明
`CompositeByteArray()` Creates a new instance of CompositeByteArray.
`CompositeByteArray(ByteArrayFactory byteArrayFactory)` Creates a new instance of CompositeByteArray.

方法概要

方法
限定符和类型	方法和说明
`void`	`addFirst(ByteArray ba)` Adds the specified `ByteArray` to the first position in the list
`void`	`addLast(ByteArray ba)` Adds the specified `ByteArray` to the end of the list
`ByteArray.Cursor`	`cursor()`
`ByteArray.Cursor`	`cursor(CompositeByteArray.CursorListener listener)` Get a cursor starting at index 0 (which may not be the start of the array) and with the given listener.
`ByteArray.Cursor`	`cursor(int index)`
`ByteArray.Cursor`	`cursor(int index, CompositeByteArray.CursorListener listener)` Get a cursor starting at the given index and with the given listener.
`boolean`	`equals(java.lang.Object other)` A ByteArray is equal to another ByteArray if they start and end at the same index, have the same byte order, and contain the same bytes at each index.
`int`	`first()`
`void`	`free()` Remove any resources associated with this object.
`byte`	`get(int index)`
`void`	`get(int index, IoBuffer bb)` Gets enough bytes to fill the `IoBuffer` from the given index.
`char`	`getChar(int index)`
`double`	`getDouble(int index)`
`ByteArray`	`getFirst()`
`float`	`getFloat(int index)`
`int`	`getInt(int index)`
`java.lang.Iterable<IoBuffer>`	`getIoBuffers()`
`long`	`getLong(int index)`
`short`	`getShort(int index)`
`IoBuffer`	`getSingleIoBuffer()`
`int`	`last()`
`int`	`length()`
`java.nio.ByteOrder`	`order()`
`void`	`order(java.nio.ByteOrder order)` Set the byte order of the array.
`void`	`put(int index, byte b)` Puts a `byte` at the given index.
`void`	`put(int index, IoBuffer bb)` Puts bytes from the `IoBuffer` at the given index.
`void`	`putChar(int index, char c)` Puts a `char` at the given index.
`void`	`putDouble(int index, double d)` Puts a `double` at the given index.
`void`	`putFloat(int index, float f)` Puts a `float` at the given index.
`void`	`putInt(int index, int i)` Puts an `int` at the given index.
`void`	`putLong(int index, long l)` Puts a `long` at the given index.
`void`	`putShort(int index, short s)` Puts a `short` at the given index.
`ByteArray`	`removeFirst()` Remove the first `ByteArray` in the list
`ByteArray`	`removeLast()` Removes the last `ByteArray` in the list
`ByteArray`	`removeTo(int index)` Remove component `ByteArray`s to the given index (splitting them if necessary) and returning them in a single `ByteArray`.
`ByteArray`	`slice(int index, int length)` Creates an array with a view of part of this array.

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

- 构造器详细资料
  - CompositeByteArray
```
public CompositeByteArray()
```
    Creates a new instance of CompositeByteArray.
  - CompositeByteArray
```
public CompositeByteArray(ByteArrayFactory byteArrayFactory)
```
    Creates a new instance of CompositeByteArray.
    
    参数:
    byteArrayFactory - The factory used to create the ByteArray objects
- 方法详细资料
  - getFirst
```
public ByteArray getFirst()
```
    返回:
    the first ByteArray in the list
  - addFirst
```
public void addFirst(ByteArray ba)
```
    Adds the specified ByteArray to the first position in the list
    
    参数:
    ba - The ByteArray to add to the list
  - removeFirst
```
public ByteArray removeFirst()
```
    Remove the first ByteArray in the list
    
    返回:
    The first ByteArray in the list
  - removeTo
```
public ByteArray removeTo(int index)
```
    Remove component ByteArrays to the given index (splitting them if necessary) and returning them in a single ByteArray. The caller is responsible for freeing the returned object. TODO: Document free behaviour more thoroughly.
    
    参数:
    index - The index from where we will remove bytes
  - addLast
```
public void addLast(ByteArray ba)
```
    Adds the specified ByteArray to the end of the list
    
    参数:
    ba - The ByteArray to add to the end of the list
  - removeLast
```
public ByteArray removeLast()
```
    Removes the last ByteArray in the list
    
    返回:
    The ByteArray that was removed
  - free
```
public void free()
```
    Remove any resources associated with this object. Using the object after this method is called may result in undefined behaviour.
  - getIoBuffers
```
public java.lang.Iterable<IoBuffer> getIoBuffers()
```
    返回:
    the sequence of IoBuffers that back this array. Compared to getSingleIoBuffer(), this method should be relatively efficient for all implementations.
  - getSingleIoBuffer
```
public IoBuffer getSingleIoBuffer()
```
    返回:
    a single IoBuffer that backs this array. Some implementations may initially have data split across multiple buffers, so calling this method may require a new buffer to be allocated and populated.
  - cursor
```
public ByteArray.Cursor cursor()
```
    返回:
    a cursor starting at index 0 (which may not be the start of the array).
  - cursor
```
public ByteArray.Cursor cursor(int index)
```
    参数:
    index - The starting point
    
    返回:
    a cursor starting at the given index.
  - cursor
```
public ByteArray.Cursor cursor(CompositeByteArray.CursorListener listener)
```
    Get a cursor starting at index 0 (which may not be the start of the array) and with the given listener.
    
    参数:
    listener - The listener to use
    
    返回:
    a new ByteArray.Cursor instance
  - cursor
```
public ByteArray.Cursor cursor(int index,
                      CompositeByteArray.CursorListener listener)
```
    Get a cursor starting at the given index and with the given listener.
    
    参数:
    index - The position of the array to start the Cursor at
    listener - The listener for the Cursor that is returned
    
    返回:
    The created Cursor
  - slice
```
public ByteArray slice(int index,
              int length)
```
    Creates an array with a view of part of this array.
    
    参数:
    index - The starting position
    length - The number of bytes to copy
    
    返回:
    The ByteArray that is a view on the original array
  - get
```
public byte get(int index)
```
    参数:
    index - The starting position
    
    返回:
    a byte from the given index.
  - put
```
public void put(int index,
       byte b)
```
    Puts a byte at the given index.
    
    参数:
    index - The position
    b - The byte to put
  - get
```
public void get(int index,
       IoBuffer bb)
```
    Gets enough bytes to fill the IoBuffer from the given index.
    
    参数:
    index - The starting position
    bb - The IoBuffer that will be filled with the bytes
  - put
```
public void put(int index,
       IoBuffer bb)
```
    Puts bytes from the IoBuffer at the given index.
    
    参数:
    index - The position
    bb - The bytes to put
  - first
```
public int first()
```
    返回:
    the index of the first byte that can be accessed.
  - last
```
public int last()
```
    返回:
    the index after the last byte that can be accessed.
  - order
```
public java.nio.ByteOrder order()
```
    返回:
    the order of the bytes.
  - order
```
public void order(java.nio.ByteOrder order)
```
    Set the byte order of the array.
    
    参数:
    order - The ByteOrder to use
  - getShort
```
public short getShort(int index)
```
    参数:
    index - The starting position
    
    返回:
    a short from the given index.
  - putShort
```
public void putShort(int index,
            short s)
```
    Puts a short at the given index.
    
    参数:
    index - The position
    s - The short to put
  - getInt
```
public int getInt(int index)
```
    参数:
    index - The starting position
    
    返回:
    an int from the given index.
  - putInt
```
public void putInt(int index,
          int i)
```
    Puts an int at the given index.
    
    参数:
    index - The position
    i - The int to put
  - getLong
```
public long getLong(int index)
```
    参数:
    index - The starting position
    
    返回:
    a long from the given index.
  - putLong
```
public void putLong(int index,
           long l)
```
    Puts a long at the given index.
    
    参数:
    index - The position
    l - The long to put
  - getFloat
```
public float getFloat(int index)
```
    参数:
    index - The starting position
    
    返回:
    a float from the given index.
  - putFloat
```
public void putFloat(int index,
            float f)
```
    Puts a float at the given index.
    
    参数:
    index - The position
    f - The float to put
  - getDouble
```
public double getDouble(int index)
```
    参数:
    index - The starting position
    
    返回:
    a double from the given index.
  - putDouble
```
public void putDouble(int index,
             double d)
```
    Puts a double at the given index.
    
    参数:
    index - The position
    d - The doubvle to put
  - getChar
```
public char getChar(int index)
```
    参数:
    index - The starting position
    
    返回:
    a char from the given index.
  - putChar
```
public void putChar(int index,
           char c)
```
    Puts a char at the given index.
    
    参数:
    index - The position
    c - The char to put
  - length
```
public final int length()
```
    指定者:
    
    length 在接口中 IoAbsoluteReader
    
    返回:
    the total number of bytes that can be accessed.
  - equals
```
public final boolean equals(java.lang.Object other)
```
    A ByteArray is equal to another ByteArray if they start and end at the same index, have the same byte order, and contain the same bytes at each index.
    
    指定者:
    
    equals 在接口中 ByteArray
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    other - The ByteArray we want to compare with
    
    返回:
    true if both ByteArray are equals

类 CompositeByteArray

嵌套类概要

从接口继承的嵌套类/接口 org.apache.mina.util.byteaccess.ByteArray

构造器概要

方法概要

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

构造器详细资料

CompositeByteArray

CompositeByteArray

方法详细资料

getFirst

addFirst

removeFirst

removeTo

addLast

removeLast

free

getIoBuffers

getSingleIoBuffer

cursor

cursor

cursor

cursor

slice

get

put

get

put

first

last

order

order

getShort

putShort

getInt

putInt

getLong

putLong

getFloat

putFloat

getDouble

putDouble

getChar

putChar

length

equals