Skip to content

Commit 2b02935

Browse files
jhoellerjhoeller
committed
Consistent use of "URI variables" terminology
Issue: SPR-14969 (cherry picked from commit 7a8ec4f)
1 parent 66aeeed commit 2b02935

File tree

5 files changed

+74
-74
lines changed

5 files changed

+74
-74
lines changed

‎spring-test/src/main/java/org/springframework/test/web/servlet/request/MockHttpServletRequestBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public class MockHttpServletRequestBuilder
129129
* {@link #with(RequestPostProcessor)}.
130130
* @param httpMethod the HTTP method (GET, POST, etc)
131131
* @param url a URL template; the resulting URL will be encoded
132-
* @param vars zero or more URL variables
132+
* @param vars zero or more URI variables
133133
*/
134134
MockHttpServletRequestBuilder(HttpMethod httpMethod, String url, Object... vars) {
135135
this(httpMethod.name(), UriComponentsBuilder.fromUriString(url).buildAndExpand(vars).encode().toUri());

‎spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMultipartHttpServletRequestBuilder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2015 the original author or authors.
2+
* Copyright 2002-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -46,10 +46,10 @@ public class MockMultipartHttpServletRequestBuilder extends MockHttpServletReque
4646
* see {@link #with(RequestPostProcessor)} and the
4747
* {@link RequestPostProcessor} extension point.
4848
* @param urlTemplate a URL template; the resulting URL will be encoded
49-
* @param urlVariables zero or more URL variables
49+
* @param uriVariables zero or more URI variables
5050
*/
51-
MockMultipartHttpServletRequestBuilder(String urlTemplate, Object... urlVariables) {
52-
super(HttpMethod.POST, urlTemplate, urlVariables);
51+
MockMultipartHttpServletRequestBuilder(String urlTemplate, Object... uriVariables) {
52+
super(HttpMethod.POST, urlTemplate, uriVariables);
5353
super.contentType(MediaType.MULTIPART_FORM_DATA);
5454
}
5555

‎spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ public abstract class MockMvcRequestBuilders {
5050
/**
5151
* Create a {@link MockHttpServletRequestBuilder} for a GET request.
5252
* @param urlTemplate a URL template; the resulting URL will be encoded
53-
* @param urlVars zero or more URL variables
53+
* @param uriVars zero or more URI variables
5454
*/
55-
public static MockHttpServletRequestBuilder get(String urlTemplate, Object... urlVars) {
56-
return new MockHttpServletRequestBuilder(HttpMethod.GET, urlTemplate, urlVars);
55+
public static MockHttpServletRequestBuilder get(String urlTemplate, Object... uriVars) {
56+
return new MockHttpServletRequestBuilder(HttpMethod.GET, urlTemplate, uriVars);
5757
}
5858

5959
/**
@@ -68,10 +68,10 @@ public static MockHttpServletRequestBuilder get(URI uri) {
6868
/**
6969
* Create a {@link MockHttpServletRequestBuilder} for a POST request.
7070
* @param urlTemplate a URL template; the resulting URL will be encoded
71-
* @param urlVars zero or more URL variables
71+
* @param uriVars zero or more URI variables
7272
*/
73-
public static MockHttpServletRequestBuilder post(String urlTemplate, Object... urlVars) {
74-
return new MockHttpServletRequestBuilder(HttpMethod.POST, urlTemplate, urlVars);
73+
public static MockHttpServletRequestBuilder post(String urlTemplate, Object... uriVars) {
74+
return new MockHttpServletRequestBuilder(HttpMethod.POST, urlTemplate, uriVars);
7575
}
7676

7777
/**
@@ -86,10 +86,10 @@ public static MockHttpServletRequestBuilder post(URI uri) {
8686
/**
8787
* Create a {@link MockHttpServletRequestBuilder} for a PUT request.
8888
* @param urlTemplate a URL template; the resulting URL will be encoded
89-
* @param urlVars zero or more URL variables
89+
* @param uriVars zero or more URI variables
9090
*/
91-
public static MockHttpServletRequestBuilder put(String urlTemplate, Object... urlVars) {
92-
return new MockHttpServletRequestBuilder(HttpMethod.PUT, urlTemplate, urlVars);
91+
public static MockHttpServletRequestBuilder put(String urlTemplate, Object... uriVars) {
92+
return new MockHttpServletRequestBuilder(HttpMethod.PUT, urlTemplate, uriVars);
9393
}
9494

9595
/**
@@ -104,10 +104,10 @@ public static MockHttpServletRequestBuilder put(URI uri) {
104104
/**
105105
* Create a {@link MockHttpServletRequestBuilder} for a PATCH request.
106106
* @param urlTemplate a URL template; the resulting URL will be encoded
107-
* @param urlVars zero or more URL variables
107+
* @param uriVars zero or more URI variables
108108
*/
109-
public static MockHttpServletRequestBuilder patch(String urlTemplate, Object... urlVars) {
110-
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, urlTemplate, urlVars);
109+
public static MockHttpServletRequestBuilder patch(String urlTemplate, Object... uriVars) {
110+
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, urlTemplate, uriVars);
111111
}
112112

113113
/**
@@ -122,10 +122,10 @@ public static MockHttpServletRequestBuilder patch(URI uri) {
122122
/**
123123
* Create a {@link MockHttpServletRequestBuilder} for a DELETE request.
124124
* @param urlTemplate a URL template; the resulting URL will be encoded
125-
* @param urlVars zero or more URL variables
125+
* @param uriVars zero or more URI variables
126126
*/
127-
public static MockHttpServletRequestBuilder delete(String urlTemplate, Object... urlVars) {
128-
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, urlTemplate, urlVars);
127+
public static MockHttpServletRequestBuilder delete(String urlTemplate, Object... uriVars) {
128+
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, urlTemplate, uriVars);
129129
}
130130

131131
/**
@@ -140,10 +140,10 @@ public static MockHttpServletRequestBuilder delete(URI uri) {
140140
/**
141141
* Create a {@link MockHttpServletRequestBuilder} for an OPTIONS request.
142142
* @param urlTemplate a URL template; the resulting URL will be encoded
143-
* @param urlVars zero or more URL variables
143+
* @param uriVars zero or more URI variables
144144
*/
145-
public static MockHttpServletRequestBuilder options(String urlTemplate, Object... urlVars) {
146-
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, urlTemplate, urlVars);
145+
public static MockHttpServletRequestBuilder options(String urlTemplate, Object... uriVars) {
146+
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, urlTemplate, uriVars);
147147
}
148148

149149
/**
@@ -158,11 +158,11 @@ public static MockHttpServletRequestBuilder options(URI uri) {
158158
/**
159159
* Create a {@link MockHttpServletRequestBuilder} for a HEAD request.
160160
* @param urlTemplate a URL template; the resulting URL will be encoded
161-
* @param urlVars zero or more URL variables
161+
* @param uriVars zero or more URI variables
162162
* @since 4.1
163163
*/
164-
public static MockHttpServletRequestBuilder head(String urlTemplate, Object... urlVars) {
165-
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, urlTemplate, urlVars);
164+
public static MockHttpServletRequestBuilder head(String urlTemplate, Object... uriVars) {
165+
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, urlTemplate, uriVars);
166166
}
167167

168168
/**
@@ -178,10 +178,10 @@ public static MockHttpServletRequestBuilder head(URI uri) {
178178
* Create a {@link MockHttpServletRequestBuilder} for a request with the given HTTP method.
179179
* @param method the HTTP method (GET, POST, etc)
180180
* @param urlTemplate a URL template; the resulting URL will be encoded
181-
* @param urlVars zero or more URL variables
181+
* @param uriVars zero or more URI variables
182182
*/
183-
public static MockHttpServletRequestBuilder request(HttpMethod method, String urlTemplate, Object... urlVars) {
184-
return new MockHttpServletRequestBuilder(method, urlTemplate, urlVars);
183+
public static MockHttpServletRequestBuilder request(HttpMethod method, String urlTemplate, Object... uriVars) {
184+
return new MockHttpServletRequestBuilder(method, urlTemplate, uriVars);
185185
}
186186

187187
/**
@@ -207,10 +207,10 @@ public static MockHttpServletRequestBuilder request(String httpMethod, URI uri)
207207
/**
208208
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
209209
* @param urlTemplate a URL template; the resulting URL will be encoded
210-
* @param urlVars zero or more URL variables
210+
* @param uriVars zero or more URI variables
211211
*/
212-
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... urlVars) {
213-
return new MockMultipartHttpServletRequestBuilder(urlTemplate, urlVars);
212+
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... uriVars) {
213+
return new MockMultipartHttpServletRequestBuilder(urlTemplate, uriVars);
214214
}
215215

216216
/**

‎spring-web/src/main/java/org/springframework/web/client/AsyncRestTemplate.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,11 @@ public <T> ListenableFuture<ResponseEntity<T>> getForEntity(String url, Class<T>
221221

222222
@Override
223223
public <T> ListenableFuture<ResponseEntity<T>> getForEntity(String url, Class<T> responseType,
224-
Map<String, ?> urlVariables) throws RestClientException {
224+
Map<String, ?> uriVariables) throws RestClientException {
225225

226226
AsyncRequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
227227
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
228-
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
228+
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
229229
}
230230

231231
@Override
@@ -348,13 +348,13 @@ public ListenableFuture<?> put(URI url, HttpEntity<?> request) throws RestClient
348348
// DELETE
349349

350350
@Override
351-
public ListenableFuture<?> delete(String url, Object... urlVariables) throws RestClientException {
352-
return execute(url, HttpMethod.DELETE, null, null, urlVariables);
351+
public ListenableFuture<?> delete(String url, Object... uriVariables) throws RestClientException {
352+
return execute(url, HttpMethod.DELETE, null, null, uriVariables);
353353
}
354354

355355
@Override
356-
public ListenableFuture<?> delete(String url, Map<String, ?> urlVariables) throws RestClientException {
357-
return execute(url, HttpMethod.DELETE, null, null, urlVariables);
356+
public ListenableFuture<?> delete(String url, Map<String, ?> uriVariables) throws RestClientException {
357+
return execute(url, HttpMethod.DELETE, null, null, uriVariables);
358358
}
359359

360360
@Override
@@ -459,17 +459,17 @@ public <T> ListenableFuture<ResponseEntity<T>> exchange(URI url, HttpMethod meth
459459

460460
@Override
461461
public <T> ListenableFuture<T> execute(String url, HttpMethod method, AsyncRequestCallback requestCallback,
462-
ResponseExtractor<T> responseExtractor, Object... urlVariables) throws RestClientException {
462+
ResponseExtractor<T> responseExtractor, Object... uriVariables) throws RestClientException {
463463

464-
URI expanded = getUriTemplateHandler().expand(url, urlVariables);
464+
URI expanded = getUriTemplateHandler().expand(url, uriVariables);
465465
return doExecute(expanded, method, requestCallback, responseExtractor);
466466
}
467467

468468
@Override
469469
public <T> ListenableFuture<T> execute(String url, HttpMethod method, AsyncRequestCallback requestCallback,
470-
ResponseExtractor<T> responseExtractor, Map<String, ?> urlVariables) throws RestClientException {
470+
ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) throws RestClientException {
471471

472-
URI expanded = getUriTemplateHandler().expand(url, urlVariables);
472+
URI expanded = getUriTemplateHandler().expand(url, uriVariables);
473473
return doExecute(expanded, method, requestCallback, responseExtractor);
474474
}
475475

‎spring-web/src/main/java/org/springframework/web/client/RestTemplate.java

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -280,19 +280,19 @@ public UriTemplateHandler getUriTemplateHandler() {
280280
// GET
281281

282282
@Override
283-
public <T> T getForObject(String url, Class<T> responseType, Object... urlVariables) throws RestClientException {
283+
public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
284284
RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
285285
HttpMessageConverterExtractor<T> responseExtractor =
286286
new HttpMessageConverterExtractor<T>(responseType, getMessageConverters(), logger);
287-
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
287+
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
288288
}
289289

290290
@Override
291-
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> urlVariables) throws RestClientException {
291+
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
292292
RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
293293
HttpMessageConverterExtractor<T> responseExtractor =
294294
new HttpMessageConverterExtractor<T>(responseType, getMessageConverters(), logger);
295-
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
295+
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
296296
}
297297

298298
@Override
@@ -304,21 +304,21 @@ public <T> T getForObject(URI url, Class<T> responseType) throws RestClientExcep
304304
}
305305

306306
@Override
307-
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... urlVariables)
307+
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables)
308308
throws RestClientException {
309309

310310
RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
311311
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
312-
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
312+
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
313313
}
314314

315315
@Override
316-
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> urlVariables)
316+
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables)
317317
throws RestClientException {
318318

319319
RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
320320
ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
321-
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, urlVariables);
321+
return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
322322
}
323323

324324
@Override
@@ -332,13 +332,13 @@ public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws
332332
// HEAD
333333

334334
@Override
335-
public HttpHeaders headForHeaders(String url, Object... urlVariables) throws RestClientException {
336-
return execute(url, HttpMethod.HEAD, null, headersExtractor(), urlVariables);
335+
public HttpHeaders headForHeaders(String url, Object... uriVariables) throws RestClientException {
336+
return execute(url, HttpMethod.HEAD, null, headersExtractor(), uriVariables);
337337
}
338338

339339
@Override
340-
public HttpHeaders headForHeaders(String url, Map<String, ?> urlVariables) throws RestClientException {
341-
return execute(url, HttpMethod.HEAD, null, headersExtractor(), urlVariables);
340+
public HttpHeaders headForHeaders(String url, Map<String, ?> uriVariables) throws RestClientException {
341+
return execute(url, HttpMethod.HEAD, null, headersExtractor(), uriVariables);
342342
}
343343

344344
@Override
@@ -350,16 +350,16 @@ public HttpHeaders headForHeaders(URI url) throws RestClientException {
350350
// POST
351351

352352
@Override
353-
public URI postForLocation(String url, Object request, Object... urlVariables) throws RestClientException {
353+
public URI postForLocation(String url, Object request, Object... uriVariables) throws RestClientException {
354354
RequestCallback requestCallback = httpEntityCallback(request);
355-
HttpHeaders headers = execute(url, HttpMethod.POST, requestCallback, headersExtractor(), urlVariables);
355+
HttpHeaders headers = execute(url, HttpMethod.POST, requestCallback, headersExtractor(), uriVariables);
356356
return headers.getLocation();
357357
}
358358

359359
@Override
360-
public URI postForLocation(String url, Object request, Map<String, ?> urlVariables) throws RestClientException {
360+
public URI postForLocation(String url, Object request, Map<String, ?> uriVariables) throws RestClientException {
361361
RequestCallback requestCallback = httpEntityCallback(request);
362-
HttpHeaders headers = execute(url, HttpMethod.POST, requestCallback, headersExtractor(), urlVariables);
362+
HttpHeaders headers = execute(url, HttpMethod.POST, requestCallback, headersExtractor(), uriVariables);
363363
return headers.getLocation();
364364
}
365365

@@ -427,15 +427,15 @@ public <T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> res
427427
// PUT
428428

429429
@Override
430-
public void put(String url, Object request, Object... urlVariables) throws RestClientException {
430+
public void put(String url, Object request, Object... uriVariables) throws RestClientException {
431431
RequestCallback requestCallback = httpEntityCallback(request);
432-
execute(url, HttpMethod.PUT, requestCallback, null, urlVariables);
432+
execute(url, HttpMethod.PUT, requestCallback, null, uriVariables);
433433
}
434434

435435
@Override
436-
public void put(String url, Object request, Map<String, ?> urlVariables) throws RestClientException {
436+
public void put(String url, Object request, Map<String, ?> uriVariables) throws RestClientException {
437437
RequestCallback requestCallback = httpEntityCallback(request);
438-
execute(url, HttpMethod.PUT, requestCallback, null, urlVariables);
438+
execute(url, HttpMethod.PUT, requestCallback, null, uriVariables);
439439
}
440440

441441
@Override
@@ -448,13 +448,13 @@ public void put(URI url, Object request) throws RestClientException {
448448
// DELETE
449449

450450
@Override
451-
public void delete(String url, Object... urlVariables) throws RestClientException {
452-
execute(url, HttpMethod.DELETE, null, null, urlVariables);
451+
public void delete(String url, Object... uriVariables) throws RestClientException {
452+
execute(url, HttpMethod.DELETE, null, null, uriVariables);
453453
}
454454

455455
@Override
456-
public void delete(String url, Map<String, ?> urlVariables) throws RestClientException {
457-
execute(url, HttpMethod.DELETE, null, null, urlVariables);
456+
public void delete(String url, Map<String, ?> uriVariables) throws RestClientException {
457+
execute(url, HttpMethod.DELETE, null, null, uriVariables);
458458
}
459459

460460
@Override
@@ -466,16 +466,16 @@ public void delete(URI url) throws RestClientException {
466466
// OPTIONS
467467

468468
@Override
469-
public Set<HttpMethod> optionsForAllow(String url, Object... urlVariables) throws RestClientException {
469+
public Set<HttpMethod> optionsForAllow(String url, Object... uriVariables) throws RestClientException {
470470
ResponseExtractor<HttpHeaders> headersExtractor = headersExtractor();
471-
HttpHeaders headers = execute(url, HttpMethod.OPTIONS, null, headersExtractor, urlVariables);
471+
HttpHeaders headers = execute(url, HttpMethod.OPTIONS, null, headersExtractor, uriVariables);
472472
return headers.getAllow();
473473
}
474474

475475
@Override
476-
public Set<HttpMethod> optionsForAllow(String url, Map<String, ?> urlVariables) throws RestClientException {
476+
public Set<HttpMethod> optionsForAllow(String url, Map<String, ?> uriVariables) throws RestClientException {
477477
ResponseExtractor<HttpHeaders> headersExtractor = headersExtractor();
478-
HttpHeaders headers = execute(url, HttpMethod.OPTIONS, null, headersExtractor, urlVariables);
478+
HttpHeaders headers = execute(url, HttpMethod.OPTIONS, null, headersExtractor, uriVariables);
479479
return headers.getAllow();
480480
}
481481

@@ -574,17 +574,17 @@ public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Parameteri
574574

575575
@Override
576576
public <T> T execute(String url, HttpMethod method, RequestCallback requestCallback,
577-
ResponseExtractor<T> responseExtractor, Object... urlVariables) throws RestClientException {
577+
ResponseExtractor<T> responseExtractor, Object... uriVariables) throws RestClientException {
578578

579-
URI expanded = getUriTemplateHandler().expand(url, urlVariables);
579+
URI expanded = getUriTemplateHandler().expand(url, uriVariables);
580580
return doExecute(expanded, method, requestCallback, responseExtractor);
581581
}
582582

583583
@Override
584584
public <T> T execute(String url, HttpMethod method, RequestCallback requestCallback,
585-
ResponseExtractor<T> responseExtractor, Map<String, ?> urlVariables) throws RestClientException {
585+
ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) throws RestClientException {
586586

587-
URI expanded = getUriTemplateHandler().expand(url, urlVariables);
587+
URI expanded = getUriTemplateHandler().expand(url, uriVariables);
588588
return doExecute(expanded, method, requestCallback, responseExtractor);
589589
}
590590

0 commit comments

Comments
 (0)