Skip to content

Commit 224fcc1

Browse files
committed
Remove outdated Servlet environment constraints from annotation javadoc
Includes removal of PathVariable's MultiValueMap support claim. Issue: SPR-16936 (cherry picked from commit 0b64bcd)
1 parent 96eba8b commit 224fcc1

File tree

6 files changed

+17
-20
lines changed

6 files changed

+17
-20
lines changed

spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2016 the original author or authors.
2+
* Copyright 2002-2018 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.
@@ -91,9 +91,8 @@
9191
* (not declaring a response argument in the handler method signature).
9292
* </ul>
9393
*
94-
* <p>In Servlet environments, you can combine the {@code ExceptionHandler} annotation
95-
* with {@link ResponseStatus @ResponseStatus}, to define the response status
96-
* for the HTTP response.
94+
* <p>You may combine the {@code ExceptionHandler} annotation with
95+
* {@link ResponseStatus @ResponseStatus} for a specific HTTP error status.
9796
*
9897
* @author Arjen Poutsma
9998
* @author Juergen Hoeller

spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java

Lines changed: 2 additions & 2 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-2018 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.
@@ -27,7 +27,7 @@
2727
/**
2828
* Annotation which indicates that a method parameter should be bound to a
2929
* name-value pair within a path segment. Supported for {@link RequestMapping}
30-
* annotated handler methods in Servlet environments.
30+
* annotated handler methods.
3131
*
3232
* <p>If the method parameter type is {@link java.util.Map} and a matrix variable
3333
* name is specified, then the matrix variable value is converted to a

spring-web/src/main/java/org/springframework/web/bind/annotation/PathVariable.java

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2016 the original author or authors.
2+
* Copyright 2002-2018 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.
@@ -26,11 +26,9 @@
2626

2727
/**
2828
* Annotation which indicates that a method parameter should be bound to a URI template
29-
* variable. Supported for {@link RequestMapping} annotated handler methods in Servlet
30-
* environments.
29+
* variable. Supported for {@link RequestMapping} annotated handler methods.
3130
*
32-
* <p>If the method parameter is {@link java.util.Map Map&lt;String, String&gt;} or
33-
* {@link org.springframework.util.MultiValueMap MultiValueMap&lt;String, String&gt;}
31+
* <p>If the method parameter is {@link java.util.Map Map&lt;String, String&gt;}
3432
* then the map is populated with all path variable names and values.
3533
*
3634
* @author Arjen Poutsma

spring-web/src/main/java/org/springframework/web/bind/annotation/RequestBody.java

Lines changed: 2 additions & 2 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-2018 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.
@@ -30,7 +30,7 @@
3030
* method argument depending on the content type of the request. Optionally, automatic
3131
* validation can be applied by annotating the argument with {@code @Valid}.
3232
*
33-
* <p>Supported for annotated handler methods in Servlet environments.
33+
* <p>Supported for annotated handler methods.
3434
*
3535
* @author Arjen Poutsma
3636
* @since 3.0

spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2017 the original author or authors.
2+
* Copyright 2002-2018 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.
@@ -99,11 +99,11 @@
9999
String[] value() default {};
100100

101101
/**
102-
* In a Servlet environment only: the path mapping URIs (e.g. "/myPath.do").
102+
* The path mapping URIs (e.g. "/myPath.do").
103103
* Ant-style path patterns are also supported (e.g. "/myPath/*.do").
104-
* At the method level, relative paths (e.g. "edit.do") are supported within
105-
* the primary mapping expressed at the type level. Path mapping URIs may
106-
* contain placeholders (e.g. "/${connect}")
104+
* At the method level, relative paths (e.g. "edit.do") are supported
105+
* within the primary mapping expressed at the type level.
106+
* Path mapping URIs may contain placeholders (e.g. "/${connect}").
107107
* <p><b>Supported at the type level as well as at the method level!</b>
108108
* When used at the type level, all method-level mappings inherit
109109
* this primary mapping, narrowing it for a specific handler method.

spring-web/src/main/java/org/springframework/web/bind/annotation/ResponseBody.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2014 the original author or authors.
2+
* Copyright 2002-2018 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.
@@ -24,7 +24,7 @@
2424

2525
/**
2626
* Annotation that indicates a method return value should be bound to the web
27-
* response body. Supported for annotated handler methods in Servlet environments.
27+
* response body. Supported for annotated handler methods.
2828
*
2929
* <p>As of version 4.0 this annotation can also be added on the type level in
3030
* which case it is inherited and does not need to be added on the method level.

0 commit comments

Comments
 (0)