[Openutils-svn] SF.net SVN: openutils:[1086] trunk/openutils-mgnltasks/src/main/java/it/ openutils/mgnltasks

[<fg...@us...>]

Revision: 1086
          http://openutils.svn.sourceforge.net/openutils/?rev=1086&view=rev
Author:   fgiust
Date:     2009-03-12 11:55:29 +0000 (Thu, 12 Mar 2009)

Log Message:
-----------
javadocs

Modified Paths:
--------------
    trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ConditionalTask.java
    trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/CreateDefaultRepositoryAclForAllUsersTask.java
    trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ExistenceConditionalBootstrapTask.java
    trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ModuleConfigBootstrapTask.java

Modified: trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ConditionalTask.java
===================================================================
--- trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ConditionalTask.java	2009-03-12 11:45:54 UTC (rev 1085)
+++ trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ConditionalTask.java	2009-03-12 11:55:29 UTC (rev 1086)
@@ -30,19 +30,30 @@
 
 
 /**
+ * Base abstract task that executes a list of other tasks only if a specific node/nodedata doesn't already exists in the
+ * repository. Subclasses must implement the <code>verifyCondition</code> method.
  * @author molaschi
  * @version $Id$
  */
 public abstract class ConditionalTask extends AbstractTask
 {
 
+    /**
+     * Workspace to check.
+     */
     protected String workspace;
 
-    protected List<Task> tasks;
-
+    /**
+     * Handle to check.
+     */
     protected String handle;
 
     /**
+     * Subtasks that will be executed if the node doesn't exists.
+     */
+    protected List<Task> tasks;
+
+    /**
      * @param taskName
      * @param taskDescription
      */
@@ -76,22 +87,51 @@
         }
     }
 
+    /**
+     * Check if a node exists.
+     * @param hm HieararchyManager
+     * @param handle node handle
+     * @return <code>true</code> if node exists
+     */
     public boolean existsNode(HierarchyManager hm, String handle)
     {
         return hm.isExist(handle);
     }
 
+    /**
+     * Check if a nodedata exists.
+     * @param hm HieararchyManager
+     * @param handle node handle
+     * @param nodedata nodedata name
+     * @return <code>true</code> if nodedata exists
+     * @throws RepositoryException exceptions while checking content
+     */
     public boolean existsNodedata(HierarchyManager hm, String handle, String nodedata) throws RepositoryException
     {
         return hm.getContent(handle).hasNodeData(nodedata);
     }
 
+    /**
+     * Check if a nodedata exists with a specific value.
+     * @param hm HieararchyManager
+     * @param handle node handle
+     * @param nodedata nodedata name
+     * @param value expected value for nodeData
+     * @return <code>true</code> if nodedata has the same value
+     * @throws RepositoryException exceptions while checking content
+     */
     public boolean nodeDataEquals(HierarchyManager hm, String handle, String nodedata, Object value)
         throws RepositoryException
     {
         return value.equals(NodeDataUtil.getValueObject(hm.getContent(handle).getNodeData(nodedata)));
     }
 
+    /**
+     * @param hm HieararchyManager
+     * @param handle node handle
+     * @return <code>true</code> if the task must be executed
+     * @throws RepositoryException exceptions while checking content
+     */
     public abstract boolean verifyCondition(HierarchyManager hm, String handle) throws RepositoryException;
 
 }

Modified: trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/CreateDefaultRepositoryAclForAllUsersTask.java
===================================================================
--- trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/CreateDefaultRepositoryAclForAllUsersTask.java	2009-03-12 11:45:54 UTC (rev 1085)
+++ trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/CreateDefaultRepositoryAclForAllUsersTask.java	2009-03-12 11:55:29 UTC (rev 1086)
@@ -58,6 +58,9 @@
         this.permissions = permissions;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @SuppressWarnings("unchecked")
     @Override
     protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException
@@ -73,6 +76,12 @@
         }
     }
 
+    /**
+     * @param node Node
+     * @param ctx Context
+     * @throws RepositoryException
+     * @throws TaskExecutionException
+     */
     protected void operateOnChildNode(Content node, InstallContext ctx) throws RepositoryException,
         TaskExecutionException
     {

Modified: trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ExistenceConditionalBootstrapTask.java
===================================================================
--- trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ExistenceConditionalBootstrapTask.java	2009-03-12 11:45:54 UTC (rev 1085)
+++ trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ExistenceConditionalBootstrapTask.java	2009-03-12 11:55:29 UTC (rev 1086)
@@ -25,6 +25,7 @@
 
 
 /**
+ * Bootstraps a file only if a specific node doesn't already exists in the repository.
  * @author molaschi
  * @version $Id$
  */

Modified: trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ModuleConfigBootstrapTask.java
===================================================================
--- trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ModuleConfigBootstrapTask.java	2009-03-12 11:45:54 UTC (rev 1085)
+++ trunk/openutils-mgnltasks/src/main/java/it/openutils/mgnltasks/ModuleConfigBootstrapTask.java	2009-03-12 11:55:29 UTC (rev 1086)
@@ -68,6 +68,9 @@
         this.excludeRepositories.addAll(excludeRepositories);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected boolean acceptResource(InstallContext ctx, String name)
     {
@@ -86,6 +89,9 @@
         return accept;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void execute(final InstallContext installContext) throws TaskExecutionException
     {
@@ -114,6 +120,13 @@
         }
     }
 
+    /**
+     * Deletes a node
+     * @param installContext install context
+     * @param nodePath node path
+     * @throws RepositoryException
+     * @throws TaskExecutionException
+     */
     protected void deleteNode(InstallContext installContext, String nodePath) throws RepositoryException,
         TaskExecutionException
     {


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.