AbstractCodecEmbedder

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

All Implemented Interfaces:

CodecEmbedder<E>

Direct Known Subclasses:

DecoderEmbedder, EncoderEmbedder
```
abstract class AbstractCodecEmbedder<E>
extends java.lang.Object
implements CodecEmbedder<E>
```
A skeletal CodecEmbedder implementation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class AbstractCodecEmbedder.EmbeddedChannelPipeline

private class AbstractCodecEmbedder.EmbeddedChannelSink

Nested Classes
Modifier and Type	Class and Description
`private static class`	`AbstractCodecEmbedder.EmbeddedChannelPipeline`
`private class`	`AbstractCodecEmbedder.EmbeddedChannelSink`

Field Summary

Fields
Modifier and Type	Field and Description
`private Channel`	`channel`
`private ChannelPipeline`	`pipeline`
`(package private) java.util.Queue<java.lang.Object>`	`productQueue`
`private AbstractCodecEmbedder.EmbeddedChannelSink`	`sink`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCodecEmbedder(ChannelBufferFactory bufferFactory, ChannelHandler... handlers)` Creates a new embedder whose pipeline is composed of the specified handlers.
`protected`	`AbstractCodecEmbedder(ChannelHandler... handlers)` Creates a new embedder whose pipeline is composed of the specified handlers.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`configurePipeline(ChannelHandler... handlers)`
`boolean`	`finish()` Signals the pipeline that the encoding or decoding has been finished and no more data will be offered.
`private void`	`fireInitialEvents()`
`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`.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.netty.handler.codec.embedder.CodecEmbedder
offer

- Field Detail
  - channel
```
private final Channel channel
```
  - pipeline
```
private final ChannelPipeline pipeline
```
  - sink
```
private final AbstractCodecEmbedder.EmbeddedChannelSink sink
```
  - productQueue
```
final java.util.Queue<java.lang.Object> productQueue
```
- Constructor Detail
  - AbstractCodecEmbedder
```
protected AbstractCodecEmbedder(ChannelHandler... handlers)
```
    Creates a new embedder whose pipeline is composed of the specified handlers.
  - AbstractCodecEmbedder
```
protected AbstractCodecEmbedder(ChannelBufferFactory bufferFactory,
                                ChannelHandler... handlers)
```
    Creates a new embedder whose pipeline is composed of the specified handlers.
    
    Parameters:
    
    bufferFactory - the ChannelBufferFactory to be used when creating a new buffer.
- Method Detail
  - fireInitialEvents
```
private void fireInitialEvents()
```
  - configurePipeline
```
private void configurePipeline(ChannelHandler... handlers)
```
  - finish
```
public boolean finish()
```
    Description copied from interface: CodecEmbedder
    
    Signals the pipeline that the encoding or decoding has been finished and no more data will be offered.
    
    Specified by:
    
    finish in interface CodecEmbedder<E>
    
    Returns:
    
    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()
```
    Description copied from interface: CodecEmbedder
    
    Consumes an encoded or decoded output from the product queue. The output object is generated by the offered input objects.
    
    Specified by:
    
    poll in interface CodecEmbedder<E>
    
    Returns:
    
    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()
```
    Description copied from interface: 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.
    
    Specified by:
    
    peek in interface CodecEmbedder<E>
    
    Returns:
    
    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()
```
    Description copied from interface: 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.
    
    Specified by:
    
    pollAll in interface CodecEmbedder<E>
    
    Returns:
    
    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)
```
    Description copied from interface: 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.
    
    Specified by:
    
    pollAll in interface CodecEmbedder<E>
    
    Returns:
    
    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()
```
    Description copied from interface: CodecEmbedder
    
    Returns the number of encoded or decoded output in the product queue.
    
    Specified by:
    
    size in interface CodecEmbedder<E>
  - getPipeline
```
public ChannelPipeline getPipeline()
```
    Description copied from interface: CodecEmbedder
    
    Returns the ChannelPipeline that handles the input.
    
    Specified by:
    
    getPipeline in interface CodecEmbedder<E>

Class AbstractCodecEmbedder<E>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jboss.netty.handler.codec.embedder.CodecEmbedder

Field Detail

channel

pipeline

sink

productQueue

Constructor Detail

AbstractCodecEmbedder

AbstractCodecEmbedder

Method Detail

fireInitialEvents

configurePipeline

finish

getChannel

isEmpty

poll

peek

pollAll

pollAll

size

getPipeline