EncoderEmbedder (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.handler.codec.embedder.EncoderEmbedder<E>

所有已实现的接口:

CodecEmbedder<E>
```
public class EncoderEmbedder<E>
extends java.lang.Object
```
A helper that wraps an encoder so that it can be used without doing actual I/O in unit tests or higher level codecs. For example, you can encode a String into a Base64-encoded ChannelBuffer with Base64Encoder and StringEncoder without setting up the ChannelPipeline and other mock objects by yourself:
```
 String data = "foobar";

 EncoderEmbedder<ChannelBuffer> embedder = new EncoderEmbedder<>(
         new Base64Encoder(), new StringEncoder());

 embedder.offer(data);

 ChannelBuffer encoded = embedder.poll();
 assert encoded.toString(CharsetUtil.US_ASCII).equals("Zm9vYmFy");
 
```
另请参阅:
DecoderEmbedder

构造器概要

构造器
构造器和说明
`EncoderEmbedder(ChannelBufferFactory bufferFactory, ChannelDownstreamHandler... handlers)` Creates a new embedder whose pipeline is composed of the specified handlers.
`EncoderEmbedder(ChannelDownstreamHandler... handlers)` Creates a new embedder whose pipeline is composed of the specified handlers.

方法概要

方法
限定符和类型	方法和说明
`boolean`	`finish()` Signals the pipeline that the encoding or decoding has been finished and no more data will be offered.
`protected Channel`	`getChannel()` Returns the virtual `Channel` which will be used as a mock during encoding and decoding.
`ChannelPipeline`	`getPipeline()` Returns the `ChannelPipeline` that handles the input.
`protected boolean`	`isEmpty()` Returns `true` if and only if the produce queue is empty and therefore `poll()` will return `null`.
`boolean`	`offer(java.lang.Object input)` Offers an input object to the pipeline of this embedder.
`E`	`peek()` Reads an encoded or decoded output from the head of the product queue.
`E`	`poll()` Consumes an encoded or decoded output from the product queue.
`java.lang.Object[]`	`pollAll()` Consumes all encoded or decoded output from the product queue.
`<T> T[]`	`pollAll(T[] a)` Consumes all encoded or decoded output from the product queue.
`int`	`size()` Returns the number of encoded or decoded output in the product queue.

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

- 构造器详细资料
  - EncoderEmbedder
```
public EncoderEmbedder(ChannelDownstreamHandler... handlers)
```
    Creates a new embedder whose pipeline is composed of the specified handlers.
  - EncoderEmbedder
```
public EncoderEmbedder(ChannelBufferFactory bufferFactory,
               ChannelDownstreamHandler... handlers)
```
    Creates a new embedder whose pipeline is composed of the specified handlers.
    
    参数:
    bufferFactory - the ChannelBufferFactory to be used when creating a new buffer.
- 方法详细资料
  - offer
```
public boolean offer(java.lang.Object input)
```
    从接口复制的说明: CodecEmbedder
    
    Offers an input object to the pipeline of this embedder.
    
    返回:
    true if and only if there is something to read in the product queue (see CodecEmbedder.poll() and CodecEmbedder.peek())
  - finish
```
public boolean finish()
```
    从接口复制的说明: CodecEmbedder
    
    Signals the pipeline that the encoding or decoding has been finished and no more data will be offered.
    
    指定者:
    
    finish 在接口中 CodecEmbedder<E>
    
    返回:
    true if and only if there is something to read in the product queue (see CodecEmbedder.poll() and CodecEmbedder.peek())
  - getChannel
```
protected final Channel getChannel()
```
    Returns the virtual Channel which will be used as a mock during encoding and decoding.
  - isEmpty
```
protected final boolean isEmpty()
```
    Returns true if and only if the produce queue is empty and therefore poll() will return null.
  - poll
```
public final E poll()
```
    从接口复制的说明: CodecEmbedder
    
    Consumes an encoded or decoded output from the product queue. The output object is generated by the offered input objects.
    
    指定者:
    
    poll 在接口中 CodecEmbedder<E>
    
    返回:
    an encoded or decoded object. null if and only if there is no output object left in the product queue.
  - peek
```
public final E peek()
```
    从接口复制的说明: CodecEmbedder
    
    Reads an encoded or decoded output from the head of the product queue. The difference from CodecEmbedder.poll() is that it does not remove the retrieved object from the product queue.
    
    指定者:
    
    peek 在接口中 CodecEmbedder<E>
    
    返回:
    an encoded or decoded object. null if and only if there is no output object left in the product queue.
  - pollAll
```
public final java.lang.Object[] pollAll()
```
    从接口复制的说明: CodecEmbedder
    
    Consumes all encoded or decoded output from the product queue. The output object is generated by the offered input objects. The behavior of this method is identical with Collection.toArray() except that the product queue is cleared.
    
    指定者:
    
    pollAll 在接口中 CodecEmbedder<E>
    
    返回:
    an array of all encoded or decoded objects. An empty array is returned if and only if there is no output object left in the product queue.
  - pollAll
```
public final <T> T[] pollAll(T[] a)
```
    从接口复制的说明: CodecEmbedder
    
    Consumes all encoded or decoded output from the product queue. The output object is generated by the offered input objects. The behavior of this method is identical with Collection.toArray(Object[]) except that the product queue is cleared.
    
    指定者:
    
    pollAll 在接口中 CodecEmbedder<E>
    
    返回:
    an array of all encoded or decoded objects. An empty array is returned if and only if there is no output object left in the product queue.
  - size
```
public final int size()
```
    从接口复制的说明: CodecEmbedder
    
    Returns the number of encoded or decoded output in the product queue.
    
    指定者:
    
    size 在接口中 CodecEmbedder<E>
  - getPipeline
```
public ChannelPipeline getPipeline()
```
    从接口复制的说明: CodecEmbedder
    
    Returns the ChannelPipeline that handles the input.
    
    指定者:
    
    getPipeline 在接口中 CodecEmbedder<E>

类 EncoderEmbedder<E>

构造器概要

方法概要

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

构造器详细资料

EncoderEmbedder

EncoderEmbedder

方法详细资料

offer

finish

getChannel

isEmpty

poll

peek

pollAll

pollAll

size

getPipeline