From c4694a068b1110137249f713ff4b5aa5754ed0c9 Mon Sep 17 00:00:00 2001
From: buczekp <buczekp>
Date: Mon, 16 May 2011 13:41:41 +0000
Subject: [PATCH] [LMS-2104] minor cleanup and javadoc
SVN: 21322
---
.../systemsx/cisd/common/io/IHierarchicalContent.java | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContent.java b/common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContent.java
index e1c1ff86f26..776e50312f2 100644
--- a/common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContent.java
+++ b/common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContent.java
@@ -55,6 +55,14 @@ public interface IHierarchicalContent
*/
List<IHierarchicalContentNode> listMatchingNodes(String startingPath, String fileNamePattern);
- /** Cleans resources acquired to access this hierarchical content. */
+ /**
+ * Cleans resources (e.g. releases locks) acquired to access this hierarchical content.
+ * <p>
+ * For now accessing {@link IHierarchicalContentNode} from a closed content doesn't fail
+ * immediately but it is unpredictable (e.g. files may no longer be accessible). One shouldn't
+ * call any methods of {@link IHierarchicalContentNode}-s that were acquired from a content
+ * which is closed at the time of invocation of the methods. In future version such operations
+ * will fail immediately.
+ */
void close();
}
--
GitLab