Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
feign/core/src/main/java/feign/MethodMetadata.java at master · OpenFeign/feign · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
OpenFeign
feign
Repository navigation
Code
Issues
209
(209)
Pull requests
23
(23)
Actions
Projects
Wiki
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
feign
/
core
/
src
/
main
/
java
/
feign
/
MethodMetadata.java
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
269 lines (225 loc) · 6.96 KB
master
Breadcrumbs
feign
/
core
/
src
/
main
/
java
/
feign
/
MethodMetadata.java
Copy path
Top
File metadata and controls
Code
Blame
269 lines (225 loc) · 6.96 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/*
* 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
feign
.
Param
.
Expander
;
import
java
.
io
.
Serializable
;
import
java
.
lang
.
reflect
.
Method
;
import
java
.
lang
.
reflect
.
Type
;
import
java
.
util
.*;
import
java
.
util
.
stream
.
Collectors
;
public
final
class
MethodMetadata
implements
Serializable
{
private
static
final
long
serialVersionUID
=
1L
;
private
String
configKey
;
private
transient
Type
returnType
;
private
Integer
urlIndex
;
private
Integer
bodyIndex
;
private
Integer
headerMapIndex
;
private
Integer
queryMapIndex
;
private
QueryMapEncoder
queryMapEncoder
;
private
boolean
alwaysEncodeBody
;
private
transient
Type
bodyType
;
private
final
RequestTemplate
template
=
new
RequestTemplate
();
private
final
List
<
String
>
formParams
=
new
ArrayList
<
String
>();
private
final
Map
<
Integer
,
Collection
<
String
>>
indexToName
=
new
LinkedHashMap
<
Integer
,
Collection
<
String
>>();
private
final
Map
<
Integer
,
Class
<?
extends
Expander
>>
indexToExpanderClass
=
new
LinkedHashMap
<
Integer
,
Class
<?
extends
Expander
>>();
private
final
Map
<
Integer
,
Boolean
>
indexToEncoded
=
new
LinkedHashMap
<
Integer
,
Boolean
>();
private
transient
Map
<
Integer
,
Expander
>
indexToExpander
;
private
BitSet
parameterToIgnore
=
new
BitSet
();
private
boolean
ignored
;
private
boolean
bodyRequired
=
true
;
private
transient
Class
<?>
targetType
;
private
transient
Method
method
;
private
final
transient
List
<
String
>
warnings
=
new
ArrayList
<>();
MethodMetadata
() {
template
.
methodMetadata
(
this
);
}
/**
* Used as a reference to this method. For example, {@link Logger#log(String, String, Object...)
* logging} or {@link ReflectiveFeign reflective dispatch}.
*
* @see Feign#configKey(Class, java.lang.reflect.Method)
*/
public
String
configKey
() {
return
configKey
;
}
public
MethodMetadata
configKey
(
String
configKey
) {
this
.
configKey
=
configKey
;
return
this
;
}
public
Type
returnType
() {
return
returnType
;
}
public
MethodMetadata
returnType
(
Type
returnType
) {
this
.
returnType
=
returnType
;
return
this
;
}
public
Integer
urlIndex
() {
return
urlIndex
;
}
public
MethodMetadata
urlIndex
(
Integer
urlIndex
) {
this
.
urlIndex
=
urlIndex
;
return
this
;
}
public
Integer
bodyIndex
() {
return
bodyIndex
;
}
public
MethodMetadata
bodyIndex
(
Integer
bodyIndex
) {
this
.
bodyIndex
=
bodyIndex
;
return
this
;
}
public
Integer
headerMapIndex
() {
return
headerMapIndex
;
}
public
MethodMetadata
headerMapIndex
(
Integer
headerMapIndex
) {
this
.
headerMapIndex
=
headerMapIndex
;
return
this
;
}
public
Integer
queryMapIndex
() {
return
queryMapIndex
;
}
public
MethodMetadata
queryMapIndex
(
Integer
queryMapIndex
) {
this
.
queryMapIndex
=
queryMapIndex
;
return
this
;
}
public
QueryMapEncoder
queryMapEncoder
() {
return
queryMapEncoder
;
}
public
MethodMetadata
queryMapEncoder
(
QueryMapEncoder
queryMapEncoder
) {
this
.
queryMapEncoder
=
queryMapEncoder
;
return
this
;
}
@
Experimental
public
boolean
alwaysEncodeBody
() {
return
alwaysEncodeBody
;
}
@
Experimental
MethodMetadata
alwaysEncodeBody
(
boolean
alwaysEncodeBody
) {
this
.
alwaysEncodeBody
=
alwaysEncodeBody
;
return
this
;
}
/** Type corresponding to {@link #bodyIndex()}. */
public
Type
bodyType
() {
return
bodyType
;
}
public
MethodMetadata
bodyType
(
Type
bodyType
) {
this
.
bodyType
=
bodyType
;
return
this
;
}
public
RequestTemplate
template
() {
return
template
;
}
public
List
<
String
>
formParams
() {
return
formParams
;
}
public
Map
<
Integer
,
Collection
<
String
>>
indexToName
() {
return
indexToName
;
}
public
Map
<
Integer
,
Boolean
>
indexToEncoded
() {
return
indexToEncoded
;
}
/** If {@link #indexToExpander} is null, classes here will be instantiated by newInstance. */
public
Map
<
Integer
,
Class
<?
extends
Expander
>>
indexToExpanderClass
() {
return
indexToExpanderClass
;
}
/**
* After {@link #indexToExpanderClass} is populated, this is set by contracts that support runtime
* injection.
*/
public
MethodMetadata
indexToExpander
(
Map
<
Integer
,
Expander
>
indexToExpander
) {
this
.
indexToExpander
=
indexToExpander
;
return
this
;
}
/** When not null, this value will be used instead of {@link #indexToExpander()}. */
public
Map
<
Integer
,
Expander
>
indexToExpander
() {
return
indexToExpander
;
}
/**
* @param i individual parameter that should be ignored
* @return this instance
*/
public
MethodMetadata
ignoreParamater
(
int
i
) {
this
.
parameterToIgnore
.
set
(
i
);
return
this
;
}
public
BitSet
parameterToIgnore
() {
return
parameterToIgnore
;
}
public
MethodMetadata
parameterToIgnore
(
BitSet
parameterToIgnore
) {
this
.
parameterToIgnore
=
parameterToIgnore
;
return
this
;
}
/**
* @param i individual parameter to check if should be ignored
* @return true when field should not be processed by feign
*/
public
boolean
shouldIgnoreParamater
(
int
i
) {
return
parameterToIgnore
.
get
(
i
);
}
/**
* @param index
* @return true if the parameter {@code index} was already consumed by a any {@link
* MethodMetadata} holder
*/
public
boolean
isAlreadyProcessed
(
Integer
index
) {
return
index
.
equals
(
urlIndex
)
||
index
.
equals
(
bodyIndex
)
||
index
.
equals
(
headerMapIndex
)
||
index
.
equals
(
queryMapIndex
)
||
indexToName
.
containsKey
(
index
)
||
indexToExpanderClass
.
containsKey
(
index
)
||
indexToEncoded
.
containsKey
(
index
)
|| (
indexToExpander
!=
null
&&
indexToExpander
.
containsKey
(
index
))
||
parameterToIgnore
.
get
(
index
);
}
public
void
ignoreMethod
() {
this
.
ignored
=
true
;
}
public
boolean
isIgnored
() {
return
ignored
;
}
public
boolean
isBodyRequired
() {
return
bodyRequired
;
}
public
void
setBodyRequired
(
boolean
bodyRequired
) {
this
.
bodyRequired
=
bodyRequired
;
}
@
Experimental
public
MethodMetadata
targetType
(
Class
<?>
targetType
) {
this
.
targetType
=
targetType
;
return
this
;
}
@
Experimental
public
Class
<?>
targetType
() {
return
targetType
;
}
@
Experimental
public
MethodMetadata
method
(
Method
method
) {
this
.
method
=
method
;
return
this
;
}
@
Experimental
public
Method
method
() {
return
method
;
}
public
void
addWarning
(
String
warning
) {
warnings
.
add
(
warning
);
}
public
String
warnings
() {
return
warnings
.
stream
().
collect
(
Collectors
.
joining
(
"
\n
- "
,
"
\n
Warnings:
\n
- "
,
""
));
}
}
You can’t perform that action at this time.