[validation] Added javadoc for the two abstract classes
authorAntonio Moreno <antonio.moreno@openbravo.com>
Wed, 31 Mar 2010 11:34:10 +0200
changeset 6903 ffc2d0f3cec7
parent 6902 d8e5536b1186
child 6904 a3266e52e42c
[validation] Added javadoc for the two abstract classes
src-core/src/org/openbravo/buildvalidation/BuildValidation.java
src-core/src/org/openbravo/modulescript/ModuleScript.java
src-util/diagnostic/.classpath
src-util/diagnostic/.project
src-util/diagnostic/.settings/.jsdtscope
src-util/diagnostic/.settings/org.eclipse.jdt.core.prefs
src-util/diagnostic/.settings/org.eclipse.jst.common.project.facet.core.prefs
src-util/diagnostic/.settings/org.eclipse.wst.common.component
src-util/diagnostic/.settings/org.eclipse.wst.common.project.facet.core.xml
src-util/diagnostic/.settings/org.eclipse.wst.jsdt.ui.superType.container
src-util/diagnostic/.settings/org.eclipse.wst.jsdt.ui.superType.name
src-util/diagnostic/WebContent/META-INF/MANIFEST.MF
src-util/diagnostic/WebContent/WEB-INF/web.xml
src-util/diagnostic/build-create.xml
src-util/diagnostic/build.xml
src-util/diagnostic/build/.keep
src-util/diagnostic/check-ob-perms.sh
src-util/diagnostic/config/diagnostics.properties
src-util/diagnostic/config/log4j.properties
src-util/diagnostic/src/Test.java
src-util/diagnostic/src/org/openbravo/check/Check.java
src-util/diagnostic/src/org/openbravo/task/CheckDB.java
src-util/diagnostic/src/org/openbravo/task/CheckEnvironmentVariables.java
src-util/diagnostic/src/org/openbravo/task/CheckJVMVersion.java
src-util/diagnostic/src/org/openbravo/task/CheckMemory.java
src-util/diagnostic/src/org/openbravo/task/CheckTomcatAntExecution.java
src-util/diagnostic/src/org/openbravo/task/CheckTomcatFilePermissions.java
src-util/diagnostic/src/org/openbravo/task/CheckTomcatMemory.java
src-util/diagnostic/src/org/openbravo/task/CheckTomcatVersion.java
src-util/diagnostic/src/org/openbravo/task/CheckX.java
src-util/diagnostic/src/org/openbravo/task/CompareVersion.java
src-util/diagnostic/src/org/openbravo/utils/PropertiesManager.java
src-util/diagnostic/src/org/openbravo/utils/ServerConnection.java
src-util/diagnostic/src/org/openbravo/utils/Version.java
--- a/src-core/src/org/openbravo/buildvalidation/BuildValidation.java	Tue Mar 30 20:05:29 2010 +0200
+++ b/src-core/src/org/openbravo/buildvalidation/BuildValidation.java	Wed Mar 31 11:34:10 2010 +0200
@@ -10,8 +10,26 @@
 
   private ConnectionProvider cp;
 
+  /**
+   * This method must be implemented by the BuildValidations, and is used to define the actions that
+   * the script itself will take. This method will be automatically called by the
+   * BuildValidationHandler when the validation process is run (at the beginning of a rebuild,
+   * before the update.database task).
+   * 
+   * This method needs to return a list of error messages. If one or more error messages are
+   * provided, the build will stop, and the messages will be shown to the user. If an empty list is
+   * provided, the validation will be considered succesful, and the build will continue
+   * 
+   * @Return A list of error Strings
+   */
   public abstract List<String> execute();
 
+  /**
+   * This method returns a connection provider, which can be used to execute statements in the
+   * database
+   * 
+   * @return a ConnectionProvider
+   */
   protected ConnectionProvider getConnectionProvider() {
     if (cp != null) {
       return cp;
--- a/src-core/src/org/openbravo/modulescript/ModuleScript.java	Tue Mar 30 20:05:29 2010 +0200
+++ b/src-core/src/org/openbravo/modulescript/ModuleScript.java	Wed Mar 31 11:34:10 2010 +0200
@@ -7,8 +7,20 @@
 
   private ConnectionProvider cp = null;
 
+  /**
+   * This method must be implemented by the ModuleScripts, and is used to define the actions that
+   * the script itself will take. This method will be automatically called by the
+   * ModuleScriptHandler when the update.database or the update.database.mod tasks are being
+   * executed
+   */
   public abstract void execute();
 
+  /**
+   * This method returns a connection provider, which can be used to execute statements in the
+   * database
+   * 
+   * @return a ConnectionProvider
+   */
   public ConnectionProvider getConnectionProvider() {
     if (cp == null) {
       cp = new CPStandAlone("config/Openbravo.properties");