Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / derby-10.3.2.1 / java / engine / org / apache / derby / iapi / services / io / StreamStorable.java
diff --git a/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/services/io/StreamStorable.java b/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/services/io/StreamStorable.java
new file mode 100644 (file)
index 0000000..a493909
--- /dev/null
@@ -0,0 +1,59 @@
+/*\r
+\r
+   Derby - Class org.apache.derby.iapi.services.io.StreamStorable\r
+\r
+   Licensed to the Apache Software Foundation (ASF) under one or more\r
+   contributor license agreements.  See the NOTICE file distributed with\r
+   this work for additional information regarding copyright ownership.\r
+   The ASF licenses this file to you under the Apache License, Version 2.0\r
+   (the "License"); you may not use this file except in compliance with\r
+   the License.  You may obtain a copy of the License at\r
+\r
+      http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+   Unless required by applicable law or agreed to in writing, software\r
+   distributed under the License is distributed on an "AS IS" BASIS,\r
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+   See the License for the specific language governing permissions and\r
+   limitations under the License.\r
+\r
+ */\r
+\r
+package org.apache.derby.iapi.services.io;\r
+import org.apache.derby.iapi.error.StandardException;\r
+import java.io.InputStream;\r
+\r
+/**\r
+ * Streaming interface for a data value. The format of\r
+ * the stream is data type dependent and represents the\r
+ * on-disk format of the value. That is it is different\r
+ * to the value an application will see through JDBC\r
+ * with methods like getBinaryStream and getAsciiStream.\r
+ * \r
+ * <BR>\r
+ * If the value is NULL (DataValueDescriptor.isNull returns\r
+ * true then these methods should not be used to get the value.\r
+\r
+  @see Formatable\r
+ */\r
+public interface StreamStorable\r
+{\r
+       /**\r
+         Return the on-disk stream state of the object.\r
+         \r
+       **/\r
+       public InputStream returnStream();\r
+\r
+       /**\r
+         sets the on-disk stream state for the object.\r
+       **/\r
+       public void setStream(InputStream newStream);\r
+\r
+       /**\r
+     * Set the value by reading the stream and\r
+     * converting it to an object form.\r
+     * \r
+               @exception StandardException on error\r
+       **/\r
+       public void loadStream() throws StandardException;\r
+}\r