Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / derby-10.3.2.1 / java / engine / org / apache / derby / iapi / jdbc / EngineLOB.java
diff --git a/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/jdbc/EngineLOB.java b/JMCR-Stable/real-world application/derby-10.3.2.1/java/engine/org/apache/derby/iapi/jdbc/EngineLOB.java
new file mode 100644 (file)
index 0000000..6cba793
--- /dev/null
@@ -0,0 +1,55 @@
+/*\r
+\r
+   Derby - Class org.apache.derby.iapi.jdbc.EngineLOB\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.jdbc;\r
+\r
+import java.sql.SQLException;\r
+\r
+/**\r
+ * Additional methods the embedded engine exposes on all of its large object\r
+ * (LOB) implementations.\r
+ * <p>\r
+ * An internal API only, mainly for the network server.\r
+ * <p>\r
+ * <b>Implementation note</b>: If a new method is needed, that only applies to\r
+ * one specific large object type (for instance a Blob), one should consider\r
+ * creating a new interface that extends from this one.\r
+ */\r
+public interface EngineLOB {\r
+\r
+    /**\r
+     * Returns LOB locator key.\r
+     * <p>\r
+     * The key can be used with\r
+     * {@link org.apache.derby.impl.jdbc.EmbedConnection#getLOBMapping} to\r
+     * retrieve this LOB at a later time.\r
+     *\r
+     * @return Locator key for this LOB\r
+     */\r
+    public int getLocator();\r
+\r
+    /**\r
+     * Frees all resources assoicated with this LOB.\r
+     *\r
+     * @throws SQLException if an error occurs during cleanup\r
+     */\r
+    public void free() throws SQLException;\r
+}\r