FilesExpand file tree

master

/

QueryMap.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

105 lines (96 loc) · 3.46 KB

master

/

QueryMap.java

Copy path

Top

File metadata and controls

• Code
• Blame

105 lines (96 loc) · 3.46 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

/*

* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)

*

* 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 static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import feign.querymap.BeanQueryMapEncoder;

import feign.querymap.FieldQueryMapEncoder;

import java.lang.annotation.Retention;

import java.util.List;

import java.util.Map;

/**

* A template parameter that can be applied to a Map that contains query parameters, where the keys

* are Strings that are the parameter names and the values are the parameter values. The queries

* specified by the map will be applied to the request after all other processing, and will take

* precedence over any previously specified query parameters. It is not necessary to reference the

* parameter map as a variable. <br>

* <br>

*

* <pre>

* ...

* &#64;RequestLine("POST /servers")

* void servers(&#64;QueryMap Map<String, String>);

* ...

*

* &#64;RequestLine("GET /servers/{serverId}?count={count}")

* void get(&#64;Param("serverId") String serverId, &#64;Param("count") int count, &#64;QueryMap Map<String, Object>);

* ...

* </pre>

*

* The annotated parameter must be an instance of {@link Map}, and the keys must be Strings. The

* query value of a key will be the value of its toString method, except in the following cases:

* <br>

* <br>

*

* <ul>

* <li>if the value is null, the value will remain null (rather than converting to the String

* "null")

* <li>if the value is an {@link Iterable}, it is converted to a {@link List} of String objects

* where each value in the list is either null if the original value was null or the value's

* toString representation otherwise.

* </ul>

*

* <br>

* Once this conversion is applied, the query keys and resulting String values follow the same

* contract as if they were set using {@link RequestTemplate#query(String, String...)}.

*/

@Retention(RUNTIME)

@java.lang.annotation.Target(PARAMETER)

public @interface QueryMap {

/**

* Specifies whether parameter names and values are already encoded.

*

* <p>Deprecation: there are two options

*

* <ul>

* <li>if name or value are already encoded we do nothing;

* <li>if name or value are not encoded we encode them.

* </ul>

*

* @see Param#encoded

* @deprecated

*/

boolean encoded() default false;

/**

* Specifies the QueryMapEncoder implementation to use to transform DTO into query map.

*

* @return the enum containing the instance of QueryMapEncoder

*/

MapEncoder mapEncoder() default MapEncoder.DEFAULT;

public enum MapEncoder {

// the latter DEFAULT will use BaseBuilder instance

BEAN(new BeanQueryMapEncoder()),

FIELD(new FieldQueryMapEncoder()),

DEFAULT(null);

private QueryMapEncoder mapEncoder;

private MapEncoder(QueryMapEncoder mapEncoder) {

this.mapEncoder = mapEncoder;

}

public QueryMapEncoder instance() {

return mapEncoder;

}

}

}