forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEncoder.java
More file actions
75 lines (73 loc) · 2.24 KB
/
Encoder.java
File metadata and controls
75 lines (73 loc) · 2.24 KB
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
/*
* Copyright 2013 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package feign.codec;
/**
* Encodes an object into an HTTP request body. Like
* {@code javax.websocket.Encoder}. <br>
* {@code Encoder} is used when a method parameter has no {@code *Param}
* annotation. For example: <br>
* <p/>
* <pre>
* @POST
* @Path("/")
* void create(User user);
* </pre>
* <p/>
* <h3>Form encoding</h3>
* <br>
* If any parameters are found in {@link feign.MethodMetadata#formParams()}, they will be
* collected and passed to {@code Encoder.Text<Map<String, ?>>}.
* <br>
* <pre>
* @POST
* @Path("/")
* Session login(@Named("username") String username, @Named("password") String password);
* </pre>
*
* @param <T> widest type an instance of this can encode.
*/
public interface Encoder<T> {
/**
* Converts objects to an appropriate text representation. <br>
* Ex. <br>
* <p/>
* <pre>
* public class GsonEncoder implements Encoder.Text<Object> {
* private final Gson gson;
*
* public GsonEncoder(Gson gson) {
* this.gson = gson;
* }
*
* @Override
* public String encode(Object object) {
* return gson.toJson(object);
* }
* }
* </pre>
*/
interface Text<T> extends Encoder<T> {
/**
* Implement this to encode an object as a String.. If you need to wrap
* exceptions, please do so via {@link EncodeException}
*
* @param object what to encode as the request body.
* @return the encoded object as a string. * @throws EncodeException
* when encoding failed due to a checked exception.
*/
String encode(T object) throws EncodeException;
}
}