forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathParam.java
More file actions
63 lines (54 loc) · 1.88 KB
/
Param.java
File metadata and controls
63 lines (54 loc) · 1.88 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
/**
* Copyright 2012-2020 The Feign Authors
*
* 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;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* A named template parameter applied to {@link Headers}, {@linkplain RequestLine},
* {@linkplain Body}, POJO fields or beans properties when it expanding
*/
@Retention(RUNTIME)
@java.lang.annotation.Target({PARAMETER, FIELD, METHOD})
public @interface Param {
/**
* The name of the template parameter.
*/
String value() default "";
/**
* How to expand the value of this parameter, if {@link ToStringExpander} isn't adequate.
*/
Class<? extends Expander> expander() default ToStringExpander.class;
/**
* {@code encoded} has been maintained for backward compatibility and should be deprecated. We no
* longer need it as values that are already pct-encoded should be identified during expansion and
* passed through without any changes
*
* @see QueryMap#encoded
* @deprecated
*/
boolean encoded() default false;
interface Expander {
/**
* Expands the value into a string. Does not accept or return null.
*/
String expand(Object value);
}
final class ToStringExpander implements Expander {
@Override
public String expand(Object value) {
return value.toString();
}
}
}