org.jboss.netty.handler.codec.embedder

Class EncoderEmbedder<E>

java.lang.Object

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

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

All Implemented Interfaces:

CodecEmbedder<E>

public class EncoderEmbedder<E>
extends AbstractCodecEmbedder<E>

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");
 

See Also:

DecoderEmbedder

Field Summary

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

productQueue

Constructor Summary

Constructors

Constructor and Description
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.

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

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.

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())