CompositeByteArrayRelativeWriter (MINA 2.0.13 API文档

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

所有已实现的接口:

IoRelativeWriter
```
public class CompositeByteArrayRelativeWriter
extends java.lang.Object
implements IoRelativeWriter
```
Provides restricted, relative, write-only access to the bytes in a CompositeByteArray. Using this interface has the advantage that it can be automatically determined when a component ByteArray can no longer be written to, and thus components can be automatically flushed. This makes it easier to use pooling for underlying ByteArrays. By providing an appropriate Expander it is also possible to automatically add more backing storage as more data is written.

TODO: Get flushing working.

作者:

Apache MINA Project

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`CompositeByteArrayRelativeWriter.ChunkedExpander` Expands the supplied `CompositeByteArray` by the number of bytes provided in the constructor
`static interface`	`CompositeByteArrayRelativeWriter.Expander` An object that knows how to expand a `CompositeByteArray`.
`static interface`	`CompositeByteArrayRelativeWriter.Flusher` An object that knows how to flush a `ByteArray`.
`static class`	`CompositeByteArrayRelativeWriter.NopExpander` No-op expander.

字段概要

字段
限定符和类型	字段和说明
`protected CompositeByteArray`	`cba` The underlying `CompositeByteArray`.
`protected ByteArray.Cursor`	`cursor` A cursor of the underlying `CompositeByteArray`.

构造器概要

构造器
构造器和说明
`CompositeByteArrayRelativeWriter(CompositeByteArray cba, CompositeByteArrayRelativeWriter.Expander expander, CompositeByteArrayRelativeWriter.Flusher flusher, boolean autoFlush)` Creates a new instance of CompositeByteArrayRelativeWriter.

方法概要

方法
限定符和类型	方法和说明
`void`	`append(ByteArray ba)` Make a `ByteArray` available for access at the end of this object.
`protected void`	`cursorPassedFirstComponent()` Called whenever the cursor has passed from the `cba`'s first component.
`void`	`flush()` Flush to the current index.
`void`	`flushTo(int index)` Flush to the given index.
`void`	`free()` Free all resources associated with this object.
`int`	`getIndex()`
`int`	`getRemaining()`
`boolean`	`hasRemaining()`
`int`	`last()`
`java.nio.ByteOrder`	`order()`
`void`	`put(byte b)` Puts a `byte` and advances the reader.
`void`	`put(IoBuffer bb)` Puts enough bytes to fill the `IoBuffer` and advances the reader.
`void`	`putChar(char c)` Puts a `char` and advances the reader.
`void`	`putDouble(double d)` Puts a `double` and advances the reader.
`void`	`putFloat(float f)` Puts a `float` and advances the reader.
`void`	`putInt(int i)` Puts an `int` and advances the reader.
`void`	`putLong(long l)` Puts a `long` and advances the reader.
`void`	`putShort(short s)` Puts a `short` and advances the reader.
`void`	`skip(int length)` Advances the writer by the given number of bytes.

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

从接口继承的方法 org.apache.mina.util.byteaccess.IoRelativeWriter
getRemaining, hasRemaining, order

- 字段详细资料
  - cba
```
protected final CompositeByteArray cba
```
    The underlying CompositeByteArray.
  - cursor
```
protected final ByteArray.Cursor cursor
```
    A cursor of the underlying CompositeByteArray. This cursor is never moved directly; its position only changes through calls to relative read or write methods.
- 构造器详细资料
  - CompositeByteArrayRelativeWriter
```
public CompositeByteArrayRelativeWriter(CompositeByteArray cba,
                                CompositeByteArrayRelativeWriter.Expander expander,
                                CompositeByteArrayRelativeWriter.Flusher flusher,
                                boolean autoFlush)
```
    Creates a new instance of CompositeByteArrayRelativeWriter.
    
    参数:
    cba - The CompositeByteArray to use to back this class
    expander - The expander. Will increase the size of the internal ByteArray
    flusher - Flushed the ByteArray when necessary
    autoFlush - Should this class automatically flush?
- 方法详细资料
  - flush
```
public void flush()
```
    Flush to the current index.
  - flushTo
```
public void flushTo(int index)
```
    Flush to the given index.
    
    参数:
    index - The end position
  - skip
```
public void skip(int length)
```
    Advances the writer by the given number of bytes.
    
    指定者:
    
    skip 在接口中 IoRelativeWriter
    
    参数:
    length - The number of bytes to skip
  - cursorPassedFirstComponent
```
protected void cursorPassedFirstComponent()
```
    Called whenever the cursor has passed from the cba's first component. As the first component is no longer used, this provides a good opportunity for subclasses to perform some action on it (such as freeing it).
  - put
```
public void put(byte b)
```
    Puts a byte and advances the reader.
    
    指定者:
    
    put 在接口中 IoRelativeWriter
    
    参数:
    b - The byte to put
  - put
```
public void put(IoBuffer bb)
```
    Puts enough bytes to fill the IoBuffer and advances the reader.
    
    指定者:
    
    put 在接口中 IoRelativeWriter
    
    参数:
    bb - The bytes to put
  - putShort
```
public void putShort(short s)
```
    Puts a short and advances the reader.
    
    指定者:
    
    putShort 在接口中 IoRelativeWriter
    
    参数:
    s - The short to put
  - putInt
```
public void putInt(int i)
```
    Puts an int and advances the reader.
    
    指定者:
    
    putInt 在接口中 IoRelativeWriter
    
    参数:
    i - The int to put
  - putLong
```
public void putLong(long l)
```
    Puts a long and advances the reader.
    
    指定者:
    
    putLong 在接口中 IoRelativeWriter
    
    参数:
    l - The long to put
  - putFloat
```
public void putFloat(float f)
```
    Puts a float and advances the reader.
    
    指定者:
    
    putFloat 在接口中 IoRelativeWriter
    
    参数:
    f - The float to put
  - putDouble
```
public void putDouble(double d)
```
    Puts a double and advances the reader.
    
    指定者:
    
    putDouble 在接口中 IoRelativeWriter
    
    参数:
    d - The double to put
  - putChar
```
public void putChar(char c)
```
    Puts a char and advances the reader.
    
    指定者:
    
    putChar 在接口中 IoRelativeWriter
    
    参数:
    c - The char to put
  - getRemaining
```
public final int getRemaining()
```
  - hasRemaining
```
public final boolean hasRemaining()
```
  - order
```
public java.nio.ByteOrder order()
```
  - append
```
public final void append(ByteArray ba)
```
    Make a ByteArray available for access at the end of this object.
    
    参数:
    ba - The ByteArray to append
  - free
```
public final void free()
```
    Free all resources associated with this object.
  - getIndex
```
public final int getIndex()
```
    返回:
    the index that will be used for the next access.
  - last
```
public final int last()
```
    返回:
    the index after the last byte that can be accessed.

类 CompositeByteArrayRelativeWriter

嵌套类概要

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.apache.mina.util.byteaccess.IoRelativeWriter

字段详细资料

cba

cursor

构造器详细资料

CompositeByteArrayRelativeWriter

方法详细资料

flush

flushTo

skip

cursorPassedFirstComponent

put

put

putShort

putInt

putLong

putFloat

putDouble

putChar

getRemaining

hasRemaining

order

append

free

getIndex

last