Minor tweaks to WebSocketMessage

philwebb · philwebb · commit ff2e9aa5bc4b · 2013-04-23T13:47:52.000-07:00
- payload is now required
- byte data is obtained and stored only once (allowing multiple calls)
- minor formatting polish
diff --git a/spring-websocket/src/main/java/org/springframework/websocket/BinaryMessage.java b/spring-websocket/src/main/java/org/springframework/websocket/BinaryMessage.java
@@ -19,6 +19,8 @@
 import java.io.InputStream;
 import java.nio.ByteBuffer;
 
+import org.springframework.util.Assert;
+
 
 /**
  * Represents a binary WebSocket message.
@@ -28,7 +30,7 @@
  */
 public final class BinaryMessage extends WebSocketMessage<ByteBuffer> {
 
-	private final byte[] bytes;
+	private byte[] bytes;
 
 	private final boolean last;
 
@@ -48,8 +50,19 @@ public BinaryMessage(byte[] payload) {
 	}
 
 	public BinaryMessage(byte[] payload, boolean isLast) {
-		super((payload != null) ? ByteBuffer.wrap(payload) : null);
-		this.bytes = payload;
+		this(payload, 0, (payload == null ? 0 : payload.length), isLast);
+	}
+
+	public BinaryMessage(byte[] payload, int offset, int len) {
+		this(payload, offset, len, true);
+	}
+
+	public BinaryMessage(byte[] payload, int offset, int len, boolean isLast) {
+		super(payload != null ? ByteBuffer.wrap(payload, offset, len) : null);
+		if(payload != null && offset == 0 && len == payload.length) {
+			// FIXME better if a message always needs a payload?
+			this.bytes = payload;
+		}
 		this.last = isLast;
 	}
 
@@ -58,17 +71,16 @@ public boolean isLast() {
 	}
 
 	public byte[] getByteArray() {
-		if (this.bytes != null) {
-			return this.bytes;
-		}
-		else if (getPayload() != null){
-			byte[] result = new byte[getPayload().remaining()];
-			getPayload().get(result);
-			return result;
-		}
-		else {
-			return null;
+		if(this.bytes == null && getPayload() != null) {
+			this.bytes = getRemainingBytes(getPayload());
 		}
+		return this.bytes;
+	}
+
+	private byte[] getRemainingBytes(ByteBuffer payload) {
+		byte[] result = new byte[getPayload().remaining()];
+		getPayload().get(result);
+		return result;
 	}
 
 	public InputStream getInputStream() {
diff --git a/spring-websocket/src/main/java/org/springframework/websocket/TextMessage.java b/spring-websocket/src/main/java/org/springframework/websocket/TextMessage.java
@@ -18,7 +18,6 @@
 import java.io.Reader;
 import java.io.StringReader;
 
-
 /**
  * Represents a text WebSocket message.
  *
@@ -27,7 +26,6 @@
  */
 public final class TextMessage extends WebSocketMessage<String> {
 
-
 	public TextMessage(String payload) {
 		super(payload);
 	}
diff --git a/spring-websocket/src/main/java/org/springframework/websocket/WebSocketMessage.java b/spring-websocket/src/main/java/org/springframework/websocket/WebSocketMessage.java
@@ -15,6 +15,7 @@
  */
 package org.springframework.websocket;
 
+import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 
 
@@ -29,6 +30,7 @@ public abstract class WebSocketMessage<T> {
 
 
 	WebSocketMessage(T payload) {
+		Assert.notNull(payload, "Payload must not be null");
 		this.payload = payload;
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@`
`18`	`18`	`import java.io.Reader;`
`19`	`19`	`import java.io.StringReader;`
`20`	`20`
`21`		`-`
`22`	`21`	`/**`
`23`	`22`	`* Represents a text WebSocket message.`
`24`	`23`	`*`
`@@ -27,7 +26,6 @@`
`27`	`26`	`*/`
`28`	`27`	`public final class TextMessage extends WebSocketMessage<String> {`
`29`	`28`
`30`		`-`
`31`	`29`	`public TextMessage(String payload) {`
`32`	`30`	`super(payload);`
`33`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.springframework.websocket;`
`17`	`17`
	`18`	`+import org.springframework.util.Assert;`
`18`	`19`	`import org.springframework.util.ObjectUtils;`
`19`	`20`
`20`	`21`
`@@ -29,6 +30,7 @@ public abstract class WebSocketMessage<T> {`
`29`	`30`
`30`	`31`
`31`	`32`	`WebSocketMessage(T payload) {`
	`33`	`+ Assert.notNull(payload, "Payload must not be null");`
`32`	`34`	`this.payload = payload;`
`33`	`35`	`}`
`34`	`36`