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 e1c1ff86f26d9d9e216c4f759c2be6adda647726..776e50312f2dd3cd0358bf471a6d4b6224ac0c9a 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(); }