summaryrefslogtreecommitdiffstats
path: root/simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java
diff options
context:
space:
mode:
Diffstat (limited to 'simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java')
-rw-r--r--simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java75
1 files changed, 75 insertions, 0 deletions
diff --git a/simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java b/simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java
new file mode 100644
index 0000000..bea3c63
--- /dev/null
+++ b/simple/simple-http/src/main/java/org/simpleframework/http/socket/BinaryData.java
@@ -0,0 +1,75 @@
+/*
+ * BinaryData.java February 2014
+ *
+ * Copyright (C) 2014, Niall Gallagher <niallg@users.sf.net>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package org.simpleframework.http.socket;
+
+/**
+ * The <code>BinaryData</code> object represents a binary payload for
+ * a WebScoket frame. This can be used to send any type of data. If
+ * however it is used to send text data then it is decoded as UTF-8.
+ *
+ * @author Niall Gallagher
+ *
+ * @see org.simpleframework.http.socket.DataFrame
+ */
+public class BinaryData implements Data {
+
+ /**
+ * This is used to convert the binary payload to text.
+ */
+ private final DataConverter converter;
+
+ /**
+ * This is the byte array that represents the binary payload.
+ */
+ private final byte[] data;
+
+ /**
+ * Constructor for the <code>BinaryData</code> object. It requires
+ * an array of binary data that will be send within a frame.
+ *
+ * @param data the byte array representing the frame payload
+ */
+ public BinaryData(byte[] data) {
+ this.converter = new DataConverter();
+ this.data = data;
+ }
+
+ /**
+ * This returns the binary payload that is to be sent with a frame.
+ * It contains no headers or other meta data. If the original data
+ * was text this converts it to UTF-8.
+ *
+ * @return the binary payload to be sent with the frame
+ */
+ public byte[] getBinary() {
+ return data;
+ }
+
+ /**
+ * This returns the text payload that is to be sent with a frame.
+ * It contains no header information or meta data. Caution should
+ * be used with this method as binary payloads will encode to
+ * garbage when decoded as UTF-8.
+ *
+ * @return the text payload to be sent with the frame
+ */
+ public String getText() {
+ return converter.convert(data);
+ }
+}