org.jboss.netty.handler.codec.embedder

Class DecoderEmbedder<E>

java.lang.Object

org.jboss.netty.handler.codec.embedder.AbstractCodecEmbedder<E>

org.jboss.netty.handler.codec.embedder.DecoderEmbedder<E>

All Implemented Interfaces:

CodecEmbedder<E>

public class DecoderEmbedder<E>
extends AbstractCodecEmbedder<E>

A helper that wraps a decoder so that it can be used without doing actual I/O in unit tests or higher level codecs. For example, you can decode a Base64-encoded ChannelBuffer with Base64Decoder and StringDecoder without setting up the ChannelPipeline and other mock objects by yourself:

 ChannelBuffer base64Data = ChannelBuffers.copiedBuffer("Zm9vYmFy", CharsetUtil.US_ASCII);

 DecoderEmbedder<String> embedder = new DecoderEmbedder<String>(
         new Base64Decoder(), new StringDecoder());

 embedder.offer(base64Data);

 String decoded = embedder.poll();
 assert decoded.equals("foobar");
 

See Also:

EncoderEmbedder

Field Summary

Fields inherited from class org.jboss.netty.handler.codec.embedder.AbstractCodecEmbedder

productQueue

Constructor Summary

Constructors

Constructor and Description
DecoderEmbedder(ChannelBufferFactory bufferFactory, ChannelUpstreamHandler... handlers) Creates a new embedder whose pipeline is composed of the specified handlers.
DecoderEmbedder(ChannelUpstreamHandler... handlers) Creates a new embedder whose pipeline is composed of the specified handlers.

Method Summary

Modifier and Type	Method and Description
boolean	offer(java.lang.Object input) Offers an input object to the pipeline of this embedder.

Methods inherited from class org.jboss.netty.handler.codec.embedder.AbstractCodecEmbedder

finish, getChannel, getPipeline, isEmpty, peek, poll, pollAll, pollAll, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DecoderEmbedder

public DecoderEmbedder(ChannelUpstreamHandler... handlers)

Creates a new embedder whose pipeline is composed of the specified handlers.

DecoderEmbedder

public DecoderEmbedder(ChannelBufferFactory bufferFactory,
                       ChannelUpstreamHandler... 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

offer

public boolean offer(java.lang.Object input)

Description copied from interface: CodecEmbedder

Offers an input object to the pipeline of this embedder.

Returns:

true if and only if there is something to read in the product queue (see CodecEmbedder.poll() and CodecEmbedder.peek())