Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryReadable.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryReadable.java
new file mode 100644 (file)
index 0000000..4053a51
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/util/binary/BinaryReadable.java
@@ -0,0 +1,60 @@
+/*******************************************************************************\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.DataInput;\r
+import java.io.EOFException;\r
+import java.io.IOException;\r
+import java.nio.ByteBuffer;\r
+
+/**
+ * BinaryReadable is a readable stream of bytes.
+ * 
+ * Common interface for ByteBuffer, byte[], InputStream, RandomAccessFile.
+ * 
+ * @see ByteBufferReadable
+ * @see InputStreamReadable
+ * @author Toni Kalajainen (toni.kalajainen@vtt.fi)
+ */
+public interface BinaryReadable extends DataInput {
+\r
+       long skipBytes(long bytes) throws IOException;\r
+    
+    /**\r
+     * Read buf fully\r
+     * \r
+     * @param buf\r
+     * @throws EOFException if this stream reaches the end before reading all\r
+     *         the bytes.\r
+     * @throws IOException if an I/O error occurs.\r
+     */
+    void readFully(ByteBuffer buf)
+    throws IOException;
+    
+    /**
+     * Read fully length bytes
+     * 
+     * @param buf
+     * @param length
+     * @throws EOFException  if this stream reaches the end before reading\r
+     *               all the bytes.\r
+     * @throws IOException   if an I/O error occurs.\r
+     */
+    void readFully(ByteBuffer buf, int length)
+    throws IOException;
+        
+       long length() throws IOException;
+    
+       long position() throws IOException;
+               
+}
+