diff --git a/spring-core/src/main/java/org/springframework/util/MimeType.java b/spring-core/src/main/java/org/springframework/util/MimeType.java index 91c182a4c06dad82cfc976fe6db609e03e91544f..894a0dc594ada12bc302b3f2279c850924dc243f 100644 --- a/spring-core/src/main/java/org/springframework/util/MimeType.java +++ b/spring-core/src/main/java/org/springframework/util/MimeType.java @@ -64,7 +64,7 @@ public class MimeType implements Comparable, Serializable { static { // variable names refer to RFC 2616, section 2.2 BitSet ctl = new BitSet(128); - for (int i=0; i <= 31; i++) { + for (int i = 0; i <= 31; i++) { ctl.set(i); } ctl.set(127); @@ -155,14 +155,14 @@ public class MimeType implements Comparable, Serializable { this.type = type.toLowerCase(Locale.ENGLISH); this.subtype = subtype.toLowerCase(Locale.ENGLISH); if (!CollectionUtils.isEmpty(parameters)) { - Map m = new LinkedCaseInsensitiveMap(parameters.size(), Locale.ENGLISH); + Map map = new LinkedCaseInsensitiveMap(parameters.size(), Locale.ENGLISH); for (Map.Entry entry : parameters.entrySet()) { String attribute = entry.getKey(); String value = entry.getValue(); checkParameters(attribute, value); - m.put(attribute, value); + map.put(attribute, value); } - this.parameters = Collections.unmodifiableMap(m); + this.parameters = Collections.unmodifiableMap(map); } else { this.parameters = Collections.emptyMap(); @@ -256,7 +256,7 @@ public class MimeType implements Comparable, Serializable { /** * Return the character set, as indicated by a {@code charset} parameter, if any. - * @return the character set; or {@code null} if not available + * @return the character set, or {@code null} if not available */ public Charset getCharSet() { String charSet = getParameter(PARAM_CHARSET); @@ -266,7 +266,7 @@ public class MimeType implements Comparable, Serializable { /** * Return a generic parameter value, given a parameter name. * @param name the parameter name - * @return the parameter value; or {@code null} if not present + * @return the parameter value, or {@code null} if not present */ public String getParameter(String name) { return this.parameters.get(name); @@ -274,10 +274,10 @@ public class MimeType implements Comparable, Serializable { /** * Return all generic parameter values. - * @return a read-only map, possibly empty, never {@code null} + * @return a read-only map (possibly empty, never {@code null}) */ public Map getParameters() { - return parameters; + return this.parameters; } /** diff --git a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java index 8eb3c940f154d8e25d6e9cda340a98016184f710..c0e38db6bba56a6aaa33ea22fa49662367ade8bf 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java +++ b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java @@ -362,17 +362,17 @@ public class HttpHeaders implements MultiValueMap, Serializable /** - * Set the list of acceptable {@linkplain MediaType media types}, as specified by the {@code Accept} header. - * @param acceptableMediaTypes the acceptable media types + * Set the list of acceptable {@linkplain MediaType media types}, + * as specified by the {@code Accept} header. */ public void setAccept(List acceptableMediaTypes) { set(ACCEPT, MediaType.toString(acceptableMediaTypes)); } /** - * Return the list of acceptable {@linkplain MediaType media types}, as specified by the {@code Accept} header. + * Return the list of acceptable {@linkplain MediaType media types}, + * as specified by the {@code Accept} header. *

Returns an empty list when the acceptable media types are unspecified. - * @return the acceptable media types */ public List getAccept() { String value = getFirst(ACCEPT); @@ -391,8 +391,8 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Set the list of acceptable {@linkplain Charset charsets}, as specified by the {@code Accept-Charset} header. - * @param acceptableCharsets the acceptable charsets + * Set the list of acceptable {@linkplain Charset charsets}, + * as specified by the {@code Accept-Charset} header. */ public void setAcceptCharset(List acceptableCharsets) { StringBuilder builder = new StringBuilder(); @@ -407,9 +407,8 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Return the list of acceptable {@linkplain Charset charsets}, as specified by the {@code Accept-Charset} - * header. - * @return the acceptable charsets + * Return the list of acceptable {@linkplain Charset charsets}, + * as specified by the {@code Accept-Charset} header. */ public List getAcceptCharset() { List result = new ArrayList(); @@ -434,17 +433,17 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Set the set of allowed {@link HttpMethod HTTP methods}, as specified by the {@code Allow} header. - * @param allowedMethods the allowed methods + * Set the set of allowed {@link HttpMethod HTTP methods}, + * as specified by the {@code Allow} header. */ public void setAllow(Set allowedMethods) { set(ALLOW, StringUtils.collectionToCommaDelimitedString(allowedMethods)); } /** - * Return the set of allowed {@link HttpMethod HTTP methods}, as specified by the {@code Allow} header. + * Return the set of allowed {@link HttpMethod HTTP methods}, + * as specified by the {@code Allow} header. *

Returns an empty set when the allowed methods are unspecified. - * @return the allowed methods */ public Set getAllow() { String value = getFirst(ALLOW); @@ -462,8 +461,7 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the (new) value of the {@code Cache-Control} header. - * @param cacheControl the value of the header + * Set the (new) value of the {@code Cache-Control} header. */ public void setCacheControl(String cacheControl) { set(CACHE_CONTROL, cacheControl); @@ -471,23 +469,20 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the value of the {@code Cache-Control} header. - * @return the value of the header */ public String getCacheControl() { return getFirst(CACHE_CONTROL); } /** - * Sets the (new) value of the {@code Connection} header. - * @param connection the value of the header + * Set the (new) value of the {@code Connection} header. */ public void setConnection(String connection) { set(CONNECTION, connection); } /** - * Sets the (new) value of the {@code Connection} header. - * @param connection the value of the header + * Set the (new) value of the {@code Connection} header. */ public void setConnection(List connection) { set(CONNECTION, toCommaDelimitedString(connection)); @@ -495,16 +490,15 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the value of the {@code Connection} header. - * @return the value of the header */ public List getConnection() { return getFirstValueAsList(CONNECTION); } /** - * Sets the (new) value of the {@code Content-Disposition} header for {@code form-data}. + * Set the (new) value of the {@code Content-Disposition} header for {@code form-data}. * @param name the control name - * @param filename the filename, may be {@code null} + * @param filename the filename (may be {@code null}) */ public void setContentDispositionFormData(String name, String filename) { Assert.notNull(name, "'name' must not be null"); @@ -518,17 +512,17 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Set the length of the body in bytes, as specified by the {@code Content-Length} header. - * @param contentLength the content length + * Set the length of the body in bytes, + * as specified by the {@code Content-Length} header. */ public void setContentLength(long contentLength) { set(CONTENT_LENGTH, Long.toString(contentLength)); } /** - * Return the length of the body in bytes, as specified by the {@code Content-Length} header. + * Return the length of the body in bytes, + * as specified by the {@code Content-Length} header. *

Returns -1 when the content-length is unknown. - * @return the content length */ public long getContentLength() { String value = getFirst(CONTENT_LENGTH); @@ -536,8 +530,8 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Set the {@linkplain MediaType media type} of the body, as specified by the {@code Content-Type} header. - * @param mediaType the media type + * Set the {@linkplain MediaType media type} of the body, + * as specified by the {@code Content-Type} header. */ public void setContentType(MediaType mediaType) { Assert.isTrue(!mediaType.isWildcardType(), "'Content-Type' cannot contain wildcard type '*'"); @@ -548,7 +542,6 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Return the {@linkplain MediaType media type} of the body, as specified by the {@code Content-Type} header. *

Returns {@code null} when the content-type is unknown. - * @return the content type */ public MediaType getContentType() { String value = getFirst(CONTENT_TYPE); @@ -556,18 +549,20 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the date and time at which the message was created, as specified by the {@code Date} header. - *

The date should be specified as the number of milliseconds since January 1, 1970 GMT. - * @param date the date + * Set the date and time at which the message was created, + * as specified by the {@code Date} header. + *

The date should be specified as the number of milliseconds + * since January 1, 1970 GMT. */ public void setDate(long date) { setDate(DATE, date); } /** - * Returns the date and time at which the message was created, as specified by the {@code Date} header. - *

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown. - * @return the creation date/time + * Returns the date and time at which the message was created, + * as specified by the {@code Date} header. + *

The date is returned as the number of milliseconds + * since January 1, 1970 GMT. Returns -1 when the date is unknown. * @throws IllegalArgumentException if the value can't be converted to a date */ public long getDate() { @@ -575,12 +570,12 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the (new) entity tag of the body, as specified by the {@code ETag} header. - * @param eTag the new entity tag + * Set the (new) entity tag of the body, as specified by the {@code ETag} header. */ public void setETag(String eTag) { if (eTag != null) { - Assert.isTrue(eTag.startsWith("\"") || eTag.startsWith("W/"), "Invalid eTag, does not start with W/ or \""); + Assert.isTrue(eTag.startsWith("\"") || eTag.startsWith("W/"), + "Invalid eTag, does not start with W/ or \""); Assert.isTrue(eTag.endsWith("\""), "Invalid eTag, does not end with \""); } set(ETAG, eTag); @@ -588,27 +583,27 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the entity tag of the body, as specified by the {@code ETag} header. - * @return the entity tag */ public String getETag() { return getFirst(ETAG); } /** - * Sets the date and time at which the message is no longer valid, as specified by the {@code Expires} header. - *

The date should be specified as the number of milliseconds since January 1, 1970 GMT. - * @param expires the new expires header value + * Set the date and time at which the message is no longer valid, + * as specified by the {@code Expires} header. + *

The date should be specified as the number of milliseconds + * since January 1, 1970 GMT. */ public void setExpires(long expires) { setDate(EXPIRES, expires); } /** - * Returns the date and time at which the message is no longer valid, as specified by - * the {@code Expires} header. - *

The date is returned as the number of milliseconds since January 1, 1970 GMT. + * Returns the date and time at which the message is no longer valid, + * as specified by the {@code Expires} header. + *

The date is returned as the number of milliseconds + * since January 1, 1970 GMT. * Returns -1 when the date is unknown. - * @return the expires value */ public long getExpires() { try { @@ -620,9 +615,9 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the (new) value of the {@code If-Modified-Since} header. - *

The date should be specified as the number of milliseconds since January 1, 1970 GMT. - * @param ifModifiedSince the new value of the header + * Set the (new) value of the {@code If-Modified-Since} header. + *

The date should be specified as the number of milliseconds + * since January 1, 1970 GMT. */ public void setIfModifiedSince(long ifModifiedSince) { setDate(IF_MODIFIED_SINCE, ifModifiedSince); @@ -630,8 +625,8 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the value of the {@code IfModifiedSince} header. - *

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown. - * @return the header value + *

The date is returned as the number of milliseconds + * since January 1, 1970 GMT. Returns -1 when the date is unknown. * @deprecated use {@link #getIfModifiedSince()} */ @Deprecated @@ -641,24 +636,22 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the value of the {@code If-Modified-Since} header. - *

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown. - * @return the header value + *

The date is returned as the number of milliseconds + * since January 1, 1970 GMT. Returns -1 when the date is unknown. */ public long getIfModifiedSince() { return getFirstDate(IF_MODIFIED_SINCE); } /** - * Sets the (new) value of the {@code If-None-Match} header. - * @param ifNoneMatch the new value of the header + * Set the (new) value of the {@code If-None-Match} header. */ public void setIfNoneMatch(String ifNoneMatch) { set(IF_NONE_MATCH, ifNoneMatch); } /** - * Sets the (new) values of the {@code If-None-Match} header. - * @param ifNoneMatchList the new value of the header + * Set the (new) values of the {@code If-None-Match} header. */ public void setIfNoneMatch(List ifNoneMatchList) { set(IF_NONE_MATCH, toCommaDelimitedString(ifNoneMatchList)); @@ -677,8 +670,7 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Returns the value of the {@code If-None-Match} header. - * @return the header value + * Return the value of the {@code If-None-Match} header. */ public List getIfNoneMatch() { return getFirstValueAsList(IF_NONE_MATCH); @@ -686,7 +678,6 @@ public class HttpHeaders implements MultiValueMap, Serializable protected List getFirstValueAsList(String header) { List result = new ArrayList(); - String value = getFirst(header); if (value != null) { String[] tokens = value.split(",\\s*"); @@ -698,35 +689,37 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the time the resource was last changed, as specified by the {@code Last-Modified} header. - *

The date should be specified as the number of milliseconds since January 1, 1970 GMT. - * @param lastModified the last modified date + * Set the time the resource was last changed, + * as specified by the {@code Last-Modified} header. + *

The date should be specified as the number of milliseconds + * since January 1, 1970 GMT. */ public void setLastModified(long lastModified) { setDate(LAST_MODIFIED, lastModified); } /** - * Returns the time the resource was last changed, as specified by the {@code Last-Modified} header. - *

The date is returned as the number of milliseconds since January 1, 1970 GMT. Returns -1 when the date is unknown. - * @return the last modified date + * Return the time the resource was last changed, + * as specified by the {@code Last-Modified} header. + *

The date is returned as the number of milliseconds + * since January 1, 1970 GMT. Returns -1 when the date is unknown. */ public long getLastModified() { return getFirstDate(LAST_MODIFIED); } /** - * Set the (new) location of a resource, as specified by the {@code Location} header. - * @param location the location + * Set the (new) location of a resource, + * as specified by the {@code Location} header. */ public void setLocation(URI location) { set(LOCATION, location.toASCIIString()); } /** - * Return the (new) location of a resource, as specified by the {@code Location} header. + * Return the (new) location of a resource + * as specified by the {@code Location} header. *

Returns {@code null} when the location is unknown. - * @return the location */ public URI getLocation() { String value = getFirst(LOCATION); @@ -734,40 +727,35 @@ public class HttpHeaders implements MultiValueMap, Serializable } /** - * Sets the (new) value of the {@code Origin} header. - * @param origin the value of the header + * Set the (new) value of the {@code Origin} header. */ public void setOrigin(String origin) { set(ORIGIN, origin); } /** - * Returns the value of the {@code Origin} header. - * @return the value of the header + * Return the value of the {@code Origin} header. */ public String getOrigin() { return getFirst(ORIGIN); } /** - * Sets the (new) value of the {@code Pragma} header. - * @param pragma the value of the header + * Set the (new) value of the {@code Pragma} header. */ public void setPragma(String pragma) { set(PRAGMA, pragma); } /** - * Returns the value of the {@code Pragma} header. - * @return the value of the header + * Return the value of the {@code Pragma} header. */ public String getPragma() { return getFirst(PRAGMA); } /** - * Sets the (new) value of the {@code Upgrade} header. - * @param upgrade the value of the header + * Set the (new) value of the {@code Upgrade} header. */ public void setUpgrade(String upgrade) { set(UPGRADE, upgrade); @@ -775,7 +763,6 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Returns the value of the {@code Upgrade} header. - * @return the value of the header */ public String getUpgrade() { return getFirst(UPGRADE); @@ -819,7 +806,7 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Return the first header value for the given header name, if any. * @param headerName the header name - * @return the first header value; or {@code null} + * @return the first header value, or {@code null} if none */ @Override public String getFirst(String headerName) { @@ -829,7 +816,7 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Add the given, single header value under the given name. - * @param headerName the header name + * @param headerName the header name * @param headerValue the header value * @throws UnsupportedOperationException if adding headers is not supported * @see #put(String, List) @@ -847,7 +834,7 @@ public class HttpHeaders implements MultiValueMap, Serializable /** * Set the given, single header value under the given name. - * @param headerName the header name + * @param headerName the header name * @param headerValue the header value * @throws UnsupportedOperationException if adding headers is not supported * @see #put(String, List) @@ -915,8 +902,8 @@ public class HttpHeaders implements MultiValueMap, Serializable } @Override - public void putAll(Map> m) { - this.headers.putAll(m); + public void putAll(Map> map) { + this.headers.putAll(map); } @Override diff --git a/spring-web/src/main/java/org/springframework/http/ResponseEntity.java b/spring-web/src/main/java/org/springframework/http/ResponseEntity.java index 2d7d4b812819ddc91e131201852ca3f874a09c5f..ea193aac2c83cdc17429eb91e49a1c3ab590df42 100644 --- a/spring-web/src/main/java/org/springframework/http/ResponseEntity.java +++ b/spring-web/src/main/java/org/springframework/http/ResponseEntity.java @@ -18,7 +18,7 @@ package org.springframework.http; import java.net.URI; import java.util.Arrays; -import java.util.HashSet; +import java.util.LinkedHashSet; import java.util.Set; import org.springframework.util.MultiValueMap; @@ -377,7 +377,7 @@ public class ResponseEntity extends HttpEntity { @Override public BodyBuilder allow(HttpMethod... allowedMethods) { - this.headers.setAllow(new HashSet(Arrays.asList(allowedMethods))); + this.headers.setAllow(new LinkedHashSet(Arrays.asList(allowedMethods))); return this; }