org.apache.juneau.encoders

Class EncoderGroup

java.lang.Object

org.apache.juneau.encoders.EncoderGroup

public final class EncoderGroup
extends Object

Represents the group of encoders keyed by codings.

Description

Maintains a set of encoders and the codings that they can handle.

The getEncoderMatch(String) and getEncoder(String) methods are then used to find appropriate encoders for specific Accept-Encoding and Content-Encoding header values.

Match ordering

Encoders are matched against Accept-Encoding strings in the order they exist in this group.

Adding new entries will cause the entries to be prepended to the group. This allows for previous encoders to be overridden through subsequent calls.

For example, calling groupBuilder.append(E1.class,E2.class).append(E3.class, E4.class) will result in the order E3, E4, E1, E2.

Example:

// Create an encoder group with support for gzip compression. EncoderGroup g = EncoderGroup.create().append(GzipEncoder.class).build(); // Should return "gzip" String matchedCoding = g.findMatch("compress;q=1.0, gzip;q=0.8, identity;q=0.5, *;q=0"); // Get the encoder IEncoder encoder = g.getEncoder(matchedCoding);

Constructor Summary

Constructors

Constructor and Description
EncoderGroup(Encoder[] encoders) Constructor

Method Summary

Modifier and Type	Method and Description
EncoderGroupBuilder	builder() Returns a builder that's a copy of the settings on this encoder group.
static EncoderGroupBuilder	create() Instantiates a new clean-slate EncoderGroupBuilder object.
Encoder	getEncoder(String encoding) Returns the encoder registered with the specified coding (e.g.
EncoderMatch	getEncoderMatch(String acceptEncoding) Returns the coding string for the matching encoder that can handle the specified Accept-Encoding or Content-Encoding header value.
List<Encoder>	getEncoders() Returns the encoders in this group.
List<String>	getSupportedEncodings() Returns the set of codings supported by all encoders in this group.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncoderGroup

public EncoderGroup(Encoder[] encoders)

Constructor

Parameters:

encoders - The encoders to add to this group.

Method Detail

create

public static EncoderGroupBuilder create()

Instantiates a new clean-slate EncoderGroupBuilder object.

This is equivalent to simply calling new EncoderGroupBuilder().

Returns:

A new EncoderGroupBuilder object.

builder

public EncoderGroupBuilder builder()

Returns a builder that's a copy of the settings on this encoder group.

Returns:

A new EncoderGroupBuilder initialized to this group.

getEncoderMatch

public EncoderMatch getEncoderMatch(String acceptEncoding)

Returns the coding string for the matching encoder that can handle the specified Accept-Encoding or Content-Encoding header value.

Returns null if no encoders can handle it.

This method is fully compliant with the RFC2616/14.3 and 14.11 specifications.

Parameters:

acceptEncoding - The Accept-Encoding or Content-Encoding value.

Returns:

The coding value (e.g. "gzip").

getEncoder

public Encoder getEncoder(String encoding)

Returns the encoder registered with the specified coding (e.g. "gzip").

Parameters:

encoding - The coding string.

Returns:

The encoder, or null if encoder isn't registered with that coding.

getSupportedEncodings

public List<String> getSupportedEncodings()

Returns the set of codings supported by all encoders in this group.

Returns:

An unmodifiable list of codings supported by all encoders in this group. Never null.

getEncoders

public List<Encoder> getEncoders()

Returns the encoders in this group.

Returns:

An unmodifiable list of encoders in this group.