Polishing

Author: jhoeller

spring-messaging/src/main/java/org/springframework/messaging/Message.java

@@ -27,13 +27,13 @@
 public interface Message<T> {
 
 	/**
-	 * Return message headers for the message (never {@code null}).
+	 * Return the message payload.
 	 */
-	MessageHeaders getHeaders();
+	T getPayload();
 
 	/**
-	 * Return the message payload.
+	 * Return message headers for the message (never {@code null} but may be empty).
 	 */
-	T getPayload();
+	MessageHeaders getHeaders();
 
 }

spring-messaging/src/main/java/org/springframework/messaging/MessageHeaders.java

@@ -60,7 +60,7 @@
  * </pre>
  *
  * A third option is to use {@link org.springframework.messaging.support.MessageHeaderAccessor}
- * or one of its sub-classes to create specific categories of headers.
+ * or one of its subclasses to create specific categories of headers.
  *
  * @author Arjen Poutsma
  * @author Mark Fisher
@@ -135,6 +135,7 @@ public <T> T get(Object key, Class<T> type) {
 		return (T) value;
 	}
 
+
 	@Override
 	public boolean equals(Object other) {
 		return (this == other ||
@@ -193,28 +194,32 @@ public Collection<Object> values() {
 	// Unsupported Map operations
 
 	/**
-	 * Since MessageHeaders are immutable, the call to this method will result in {@link UnsupportedOperationException}.
+	 * Since MessageHeaders are immutable, the call to this method
+	 * will result in {@link UnsupportedOperationException}.
 	 */
 	public Object put(String key, Object value) {
 		throw new UnsupportedOperationException("MessageHeaders is immutable");
 	}
 
 	/**
-	 * Since MessageHeaders are immutable, the call to this method will result in {@link UnsupportedOperationException}.
+	 * Since MessageHeaders are immutable, the call to this method
+	 * will result in {@link UnsupportedOperationException}.
 	 */
-	public void putAll(Map<? extends String, ? extends Object> t) {
+	public void putAll(Map<? extends String, ? extends Object> map) {
 		throw new UnsupportedOperationException("MessageHeaders is immutable");
 	}
 
 	/**
-	 * Since MessageHeaders are immutable, the call to this method will result in {@link UnsupportedOperationException}.
+	 * Since MessageHeaders are immutable, the call to this method
+	 * will result in {@link UnsupportedOperationException}.
 	 */
 	public Object remove(Object key) {
 		throw new UnsupportedOperationException("MessageHeaders is immutable");
 	}
 
 	/**
-	 * Since MessageHeaders are immutable, the call to this method will result in {@link UnsupportedOperationException}.
+	 * Since MessageHeaders are immutable, the call to this method
+	 * will result in {@link UnsupportedOperationException}.
 	 */
 	public void clear() {
 		throw new UnsupportedOperationException("MessageHeaders is immutable");

spring-messaging/src/main/java/org/springframework/messaging/support/ErrorMessage.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,6 @@
  * @author Mark Fisher
  * @author Oleg Zhurakousky
  * @since 4.0
- *
  * @see MessageBuilder
  */
 public class ErrorMessage extends GenericMessage<Throwable> {
@@ -34,17 +33,15 @@ public class ErrorMessage extends GenericMessage<Throwable> {
 
 	/**
 	 * Create a new message with the given payload.
-	 *
-	 * @param payload the message payload, never {@code null}
+	 * @param payload the message payload (never {@code null})
 	 */
 	public ErrorMessage(Throwable payload) {
 		super(payload);
 	}
 
 	/**
 	 * Create a new message with the given payload and headers.
-	 *
-	 * @param payload the message payload, never {@code null}
+	 * @param payload the message payload (never {@code null})
 	 * @param headers message headers
 	 */
 	public ErrorMessage(Throwable payload, Map<String, Object> headers) {

spring-messaging/src/main/java/org/springframework/messaging/support/GenericMessage.java

@@ -30,7 +30,6 @@
  *
  * @author Mark Fisher
  * @since 4.0
- *
  * @see MessageBuilder
  */
 public class GenericMessage<T> implements Message<T>, Serializable {
@@ -45,32 +44,47 @@ public class GenericMessage<T> implements Message<T>, Serializable {
 
 	/**
 	 * Create a new message with the given payload.
-	 *
-	 * @param payload the message payload, never {@code null}
+	 * @param payload the message payload (never {@code null})
 	 */
 	public GenericMessage(T payload) {
-		this(payload, null);
+		this(payload, new MessageHeaders(null));
 	}
 
 	/**
 	 * Create a new message with the given payload and headers.
-	 *
-	 * @param payload the message payload, never {@code null}
+	 * @param payload the message payload (never {@code null})
 	 * @param headers message headers
 	 */
 	public GenericMessage(T payload, Map<String, Object> headers) {
-		Assert.notNull(payload, "payload must not be null");
+		Assert.notNull(payload, "Payload must not be null");
 		this.headers = new MessageHeaders(headers);
 		this.payload = payload;
 	}
 
 
+	public T getPayload() {
+		return this.payload;
+	}
+
 	public MessageHeaders getHeaders() {
 		return this.headers;
 	}
 
-	public T getPayload() {
-		return this.payload;
+
+	public boolean equals(Object obj) {
+		if (this == obj) {
+			return true;
+		}
+		if (obj != null && obj instanceof GenericMessage<?>) {
+			GenericMessage<?> other = (GenericMessage<?>) obj;
+			return (ObjectUtils.nullSafeEquals(this.headers.getId(), other.headers.getId()) &&
+					this.headers.equals(other.headers) && this.payload.equals(other.payload));
+		}
+		return false;
+	}
+
+	public int hashCode() {
+		return (this.headers.hashCode() * 23 + ObjectUtils.nullSafeHashCode(this.payload));
 	}
 
 	public String toString() {
@@ -86,20 +100,4 @@ public String toString() {
 		return sb.toString();
 	}
 
-	public int hashCode() {
-		return this.headers.hashCode() * 23 + ObjectUtils.nullSafeHashCode(this.payload);
-	}
-
-	public boolean equals(Object obj) {
-		if (this == obj) {
-			return true;
-		}
-		if (obj != null && obj instanceof GenericMessage<?>) {
-			GenericMessage<?> other = (GenericMessage<?>) obj;
-			return (this.headers.getId().equals(other.headers.getId()) &&
-					this.headers.equals(other.headers) && this.payload.equals(other.payload));
-		}
-		return false;
-	}
-
 }

spring-messaging/src/main/java/org/springframework/messaging/support/MessageHeaderAccessor.java

@@ -94,7 +94,7 @@ public Map<String, Object> toMap() {
 	}
 
 	public boolean isModified() {
-		return (!this.headers.isEmpty());
+		return !this.headers.isEmpty();
 	}
 
 	public Object getHeader(String headerName) {
@@ -132,10 +132,6 @@ protected void verifyType(String headerName, Object headerValue) {
 		}
 	}
 
-	protected boolean isReadOnly(String headerName) {
-		return MessageHeaders.ID.equals(headerName) || MessageHeaders.TIMESTAMP.equals(headerName);
-	}
-
 	/**
 	 * Set the value for the given header name only if the header name is not
 	 * already associated with a value.
@@ -146,6 +142,15 @@ public void setHeaderIfAbsent(String name, Object value) {
 		}
 	}
 
+	/**
+	 * Remove the value for the given header name.
+	 */
+	public void removeHeader(String headerName) {
+		if (StringUtils.hasLength(headerName) && !isReadOnly(headerName)) {
+			setHeader(headerName, null);
+		}
+	}
+
 	/**
 	 * Removes all headers provided via array of 'headerPatterns'.
 	 * <p>As the name suggests, array may contain simple matching patterns for header
@@ -181,15 +186,6 @@ private List<String> getMatchingHeaderNames(String pattern, Map<String, Object>
 		return matchingHeaderNames;
 	}
 
-	/**
-	 * Remove the value for the given header name.
-	 */
-	public void removeHeader(String headerName) {
-		if (StringUtils.hasLength(headerName) && !isReadOnly(headerName)) {
-			setHeader(headerName, null);
-		}
-	}
-
 	/**
 	 * Copy the name-value pairs from the provided Map.
 	 * <p>This operation will overwrite any existing values. Use
@@ -214,13 +210,18 @@ public void copyHeadersIfAbsent(Map<String, ?> headersToCopy) {
 		if (headersToCopy != null) {
 			Set<String> keys = headersToCopy.keySet();
 			for (String key : keys) {
-				if (!this.isReadOnly(key)) {
+				if (!isReadOnly(key)) {
 					setHeaderIfAbsent(key, headersToCopy.get(key));
 				}
 			}
 		}
 	}
 
+	protected boolean isReadOnly(String headerName) {
+		return (MessageHeaders.ID.equals(headerName) || MessageHeaders.TIMESTAMP.equals(headerName));
+	}
+
+
 	public UUID getId() {
 		return (UUID) getHeader(MessageHeaders.ID);
 	}
@@ -229,6 +230,10 @@ public Long getTimestamp() {
 		return (Long) getHeader(MessageHeaders.TIMESTAMP);
 	}
 
+	public void setReplyChannelName(String replyChannelName) {
+		setHeader(MessageHeaders.REPLY_CHANNEL, replyChannelName);
+	}
+
 	public void setReplyChannel(MessageChannel replyChannel) {
 		setHeader(MessageHeaders.REPLY_CHANNEL, replyChannel);
 	}
@@ -237,8 +242,8 @@ public Object getReplyChannel() {
         return getHeader(MessageHeaders.REPLY_CHANNEL);
     }
 
-	public void setReplyChannelName(String replyChannelName) {
-		setHeader(MessageHeaders.REPLY_CHANNEL, replyChannelName);
+	public void setErrorChannelName(String errorChannelName) {
+		setHeader(MessageHeaders.ERROR_CHANNEL, errorChannelName);
 	}
 
 	public void setErrorChannel(MessageChannel errorChannel) {
@@ -249,18 +254,14 @@ public Object getErrorChannel() {
         return getHeader(MessageHeaders.ERROR_CHANNEL);
     }
 
-	public void setErrorChannelName(String errorChannelName) {
-		setHeader(MessageHeaders.ERROR_CHANNEL, errorChannelName);
-	}
-
-    public MimeType getContentType() {
-        return (MimeType) getHeader(MessageHeaders.CONTENT_TYPE);
-    }
-
 	public void setContentType(MimeType contentType) {
 		setHeader(MessageHeaders.CONTENT_TYPE, contentType);
 	}
 
+	public MimeType getContentType() {
+		return (MimeType) getHeader(MessageHeaders.CONTENT_TYPE);
+	}
+
 
 	@Override
 	public String toString() {

spring-web/src/main/java/org/springframework/http/ResponseEntity.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,15 +21,19 @@
 
 /**
  * Extension of {@link HttpEntity} that adds a {@link HttpStatus} status code.
+ * Used in {@code RestTemplate} as well {@code @Controller} methods.
  *
- * <p>Returned by {@link org.springframework.web.client.RestTemplate#getForEntity}:
+ * <p>In {@code RestTemplate}, this class is returned by
+ * {@link org.springframework.web.client.RestTemplate#getForEntity getForEntity()} and
+ * {@link org.springframework.web.client.RestTemplate#exchange exchange()}:
  * <pre class="code">
  * ResponseEntity&lt;String&gt; entity = template.getForEntity("http://example.com", String.class);
  * String body = entity.getBody();
  * MediaType contentType = entity.getHeaders().getContentType();
  * HttpStatus statusCode = entity.getStatusCode();
  * </pre>
- * <p>Can also be used in Spring MVC, as a return value from a @Controller method:
+ *
+ * <p>Can also be used in Spring MVC, as the return value from a @Controller method:
  * <pre class="code">
  * &#64;RequestMapping("/handle")
  * public ResponseEntity&lt;String&gt; handle() {

spring-web/src/main/java/org/springframework/http/server/ServerHttpAsyncRequestControl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.http.server;
 
 /**
@@ -39,17 +40,17 @@ public interface ServerHttpAsyncRequestControl {
 	void start(long timeout);
 
 	/**
-	 * Whether asynchronous request processing has been started.
+	 * Return whether asynchronous request processing has been started.
 	 */
 	boolean isStarted();
 
 	/**
-	 * Causes asynchronous request processing to be completed.
+	 * Mark asynchronous request processing as completed.
 	 */
 	void complete();
 
 	/**
-	 * Whether asynchronous request processing has been completed.
+	 * Return whether asynchronous request processing has been completed.
 	 */
 	boolean isCompleted();