Top Description Inners Methods
org.eclipse.jetty.client

public Interface ContentDecoder

Known Direct Implementers
org.eclipse.jetty.client.GZIPContentDecoder
Imports
java.nio.ByteBuffer, java.util.Iterator, .LinkedHashMap, .Map, org.eclipse.jetty.http.HttpField, .HttpHeader, org.eclipse.jetty.io.RetainableByteBuffer

ContentDecoder decodes content bytes of a response.
See Also
Factory

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public abstract static class
ContentDecoder.Factory

Factory for ContentDecoders; subclasses must implement newContentDecoder().

Method Summary

Modifier and TypeMethod and Description
public default void
afterDecoding(Response response)

Processes the exchange after the response content has been decoded.

public default void
beforeDecoding(Response response)

Processes the response just before the decoding of the response content.

public RetainableByteBuffer

Returns:

a buffer containing decoded bytes
decode
(ByteBuffer
the buffer containing encoded bytes
buffer
)

Decodes the bytes in the given buffer and returns the decoded bytes.

Method Detail

afterDecodingback to summary
public default void afterDecoding(Response response)

Processes the exchange after the response content has been decoded.

Typical processing may involve modifying the response headers, for example updating the Content-Length header to the length of the decoded response content.

beforeDecodingback to summary
public default void beforeDecoding(Response response)

Processes the response just before the decoding of the response content.

Typical processing may involve modifying the response headers, for example by temporarily removing the Content-Length header, or modifying the Content-Encoding header.

decodeback to summary
public RetainableByteBuffer decode(ByteBuffer buffer)

Decodes the bytes in the given buffer and returns the decoded bytes.

The returned RetainableByteBuffer will eventually be released via RetainableByteBuffer#release() by the code that called this method.

Parameters
buffer:ByteBuffer

the buffer containing encoded bytes

Returns:RetainableByteBuffer

a buffer containing decoded bytes

org.eclipse.jetty.client back to summary

public Class ContentDecoder.Factories

extends Object
implements Iterable<ContentDecoder.Factory>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable

Field Summary

Modifier and TypeField and Description
private HttpField
private final Map<String, ContentDecoder.Factory>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public HttpField
public Iterator<ContentDecoder.Factory>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public ContentDecoder.Factory
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

acceptEncodingFieldback to summary
private HttpField acceptEncodingField
factoriesback to summary
private final Map<String, ContentDecoder.Factory> factories

Constructor Detail

Factoriesback to summary
public Factories()

Method Detail

clearback to summary
public void clear()
getAcceptEncodingFieldback to summary
public HttpField getAcceptEncodingField()
iteratorback to summary
public Iterator<ContentDecoder.Factory> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<ContentDecoder.Factory>

an Iterator.

Annotations
@Override
putback to summary
public ContentDecoder.Factory put(ContentDecoder.Factory factory)
org.eclipse.jetty.client back to summary

public abstract Class ContentDecoder.Factory

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.client.GZIPContentDecoder.Factory

Factory for ContentDecoders; subclasses must implement newContentDecoder().

Factory have an encoding, which is the string used in Accept-Encoding request header and in Content-Encoding response headers.

Factory instances are configured in HttpClient via HttpClient#getContentDecoderFactories().

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
protected
Factory(String encoding)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getEncoding()

Returns: the type of the decoders created by this factory

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public abstract ContentDecoder

Returns:

a new instance of a ContentDecoder
newContentDecoder
()

Factory method for ContentDecoders

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

encodingback to summary
private final String encoding

Constructor Detail

Factoryback to summary
protected Factory(String encoding)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getEncodingback to summary
public String getEncoding()
Returns:String

the type of the decoders created by this factory

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
newContentDecoderback to summary
public abstract ContentDecoder newContentDecoder()

Factory method for ContentDecoders

Returns:ContentDecoder

a new instance of a ContentDecoder