[LMS-2171] javadoc

SVN: 20837

common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContent.java

@@ -19,18 +19,34 @@ package ch.systemsx.cisd.common.io;
 import java.util.List;
 
 /**
+ * Abstraction of a tree-like hierarchical content on the filesystem.
+ * 
  * @author Chandrasekhar Ramakrishnan
  * @author Piotr Buczek
  */
 public interface IHierarchicalContent
 {
+    /** Returns root node. */
     IHierarchicalContentNode getRootNode();
 
+    /** Returns node with specified relative path starting from root node. */
     IHierarchicalContentNode getNode(String relativePath);
 
+    /**
+     * Returns list of all file nodes in this hierarchy with names matching given
+     * <code>pattern</code>.
+     * <p>
+     * NOTE: this operation may be expensive for huge hierarchies
+     */
     List<IHierarchicalContentNode> listMatchingNodes(String pattern);
 
+    /**
+     * Like {@link #listMatchingNodes(String)} but search starts from specified relative path.
+     * <p>
+     * NOTE: this operation may be expensive for huge hierarchies
+     */
     List<IHierarchicalContentNode> listMatchingNodes(String startingPath, String pattern);
 
+    /** Cleans resources acquired to access this hierarchical content. */
     void close();
 }

common/source/java/ch/systemsx/cisd/common/io/IHierarchicalContentFactory.java

@@ -26,8 +26,17 @@ import ch.systemsx.cisd.common.utilities.IDelegatedAction;
  */
 public interface IHierarchicalContentFactory
 {
+    /**
+     * Returns hierarchy based on given root file.
+     * 
+     * @param onCloseAction action that will be performed when returned hierarchy is closed
+     */
     public IHierarchicalContent asHierarchicalContent(File file, IDelegatedAction onCloseAction);
 
+    /**
+     * Returns content node for given file. Different implementations may be returned depending on
+     * e.g. file extension.
+     */
     public IHierarchicalContentNode asHierarchicalContentNode(IHierarchicalContent rootContent,
             File file);