blob: f811e6b0a052cec6bafded0d9fdd5e13c7d0293e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
//
// ========================================================================
// Copyright (c) 1995-2015 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.client;
import java.nio.ByteBuffer;
/**
* {@link ContentDecoder} decodes content bytes of a response.
*
* @see Factory
*/
public interface ContentDecoder
{
/**
* <p>Decodes the bytes in the given {@code buffer} and returns decoded bytes, if any.</p>
*
* @param buffer the buffer containing encoded bytes
* @return a buffer containing decoded bytes, if any
*/
public abstract ByteBuffer decode(ByteBuffer buffer);
/**
* Factory for {@link ContentDecoder}s; subclasses must implement {@link #newContentDecoder()}.
* <p>
* {@link Factory} have an {@link #getEncoding() encoding}, which is the string used in
* {@code Accept-Encoding} request header and in {@code Content-Encoding} response headers.
* <p>
* {@link Factory} instances are configured in {@link HttpClient} via
* {@link HttpClient#getContentDecoderFactories()}.
*/
public static abstract class Factory
{
private final String encoding;
protected Factory(String encoding)
{
this.encoding = encoding;
}
/**
* @return the type of the decoders created by this factory
*/
public String getEncoding()
{
return encoding;
}
@Override
public boolean equals(Object obj)
{
if (this == obj) return true;
if (!(obj instanceof Factory)) return false;
Factory that = (Factory)obj;
return encoding.equals(that.encoding);
}
@Override
public int hashCode()
{
return encoding.hashCode();
}
/**
* Factory method for {@link ContentDecoder}s
*
* @return a new instance of a {@link ContentDecoder}
*/
public abstract ContentDecoder newContentDecoder();
}
}
|
