Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.databoard / src / org / simantics / databoard / util / binary / BinaryWriteable.java

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryWriteable.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryWriteable.java
new file mode 100644 (file)
index 0000000..9c0d600
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryWriteable.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\r
+ *  Copyright (c) 2010 Association for Decentralized Information Management in\r
+ *  Industry THTH ry.\r
+ *  All rights reserved. This program and the accompanying materials\r
+ *  are made available under the terms of the Eclipse Public License v1.0\r
+ *  which accompanies this distribution, and is available at\r
+ *  http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ *  Contributors:\r
+ *      VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.databoard.util.binary;
+
+import java.io.DataOutput;\r
+import java.io.IOException;\r
+import java.nio.ByteBuffer;\r
+
+/**
+ * Writeable context
+ * 
+ * Common interface for ByteBuffer, byte[], OutputStream, RandomAccessFile.
+ * 
+ * @see ByteBufferWriteable
+ * @see OutputStreamWriteable 
+ * @author Toni Kalajainen (toni.kalajainen@vtt.fi)
+ */
+public interface BinaryWriteable extends DataOutput {
+
+    /**
+     * Put n bytes from the remaining of the byte array. 
+     * This operation moves the pointer in byte buffer.
+     * 
+     * @param src
+     * @throws IOException
+     */
+    void writeFully(ByteBuffer src) throws IOException;
+    
+    /**
+     * Put n bytes from the remaining of the byte buffer. 
+     * This operation moves the pointer in byte buffer.
+     * 
+     * @param src
+     * @param length
+     * @throws IOException
+     */
+    void writeFully(ByteBuffer src, int length) throws IOException;
+
+       /**
+        * Flush write buffer 
+        * 
+        * @throws IOException
+        */
+       void flush()
+       throws IOException;
+       
+}
+