[Mulgara-svn] r1651 - trunk/src/jar/util/java/org/mulgara/util

[pag at mulgara.org]

Author: pag
Date: 2009-04-06 09:28:17 -0700 (Mon, 06 Apr 2009)
New Revision: 1651

Added:
   trunk/src/jar/util/java/org/mulgara/util/Closable.java
Log:
Indicates that an object has a close() method for releasing resources

Added: trunk/src/jar/util/java/org/mulgara/util/Closable.java
===================================================================
--- trunk/src/jar/util/java/org/mulgara/util/Closable.java	                        (rev 0)
+++ trunk/src/jar/util/java/org/mulgara/util/Closable.java	2009-04-06 16:28:17 UTC (rev 1651)
@@ -0,0 +1,30 @@
+/*
+ * The contents of this file are subject to the Open Software License
+ * Version 3.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.opensource.org/licenses/osl-3.0.txt
+ *
+ * Software distributed under the License is distributed on an "AS IS"
+ * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ * the License for the specific language governing rights and limitations
+ * under the License.
+ */
+
+package org.mulgara.util;
+
+/**
+ * A generic interface for anything that have resources release by closing it.
+ *
+ * @created Mar 30, 2009
+ * @author Paul Gearon
+ * @copyright &copy; 2008 <a href="http://www.topazproject.org/">The Topaz Project</a>
+ * @licence <a href="{@docRoot}/../../LICENCE.txt">Open Software License v3.0</a>
+ */
+public interface Closable {
+
+  /**
+   * Release any resources associated with this object.
+   * @throws Exception Due to any error encountered while releasing the resources. 
+   */
+  public void close() throws Exception;
+}