OOZIE-2178 fix javadoc to compile on JDK8 (rkanter)
Project: http://git-wip-us.apache.org/repos/asf/oozie/repo Commit: http://git-wip-us.apache.org/repos/asf/oozie/commit/fcbab934 Tree: http://git-wip-us.apache.org/repos/asf/oozie/tree/fcbab934 Diff: http://git-wip-us.apache.org/repos/asf/oozie/diff/fcbab934 Branch: refs/heads/master Commit: fcbab934096ff135e2001253f7208fa0405c1367 Parents: f002d19 Author: Robert Kanter <[email protected]> Authored: Fri Jun 12 16:53:05 2015 -0700 Committer: Robert Kanter <[email protected]> Committed: Fri Jun 12 16:53:05 2015 -0700 ---------------------------------------------------------------------- .../java/org/apache/oozie/cli/OozieCLI.java | 10 +- .../apache/oozie/client/AuthOozieClient.java | 23 ++- .../org/apache/oozie/client/CoordinatorJob.java | 2 +- .../org/apache/oozie/client/OozieClient.java | 47 +++-- .../org/apache/oozie/client/WorkflowJob.java | 4 +- .../org/apache/oozie/client/XOozieClient.java | 4 +- .../apache/oozie/client/rest/JsonToBean.java | 2 +- .../org/apache/oozie/client/rest/JsonUtils.java | 6 +- .../main/java/org/apache/oozie/BaseEngine.java | 10 +- .../java/org/apache/oozie/BulkResponseInfo.java | 8 +- .../java/org/apache/oozie/BundleActionBean.java | 10 +- .../java/org/apache/oozie/BundleJobBean.java | 14 +- .../java/org/apache/oozie/BundleJobInfo.java | 8 +- .../org/apache/oozie/CoordinatorActionInfo.java | 2 +- .../org/apache/oozie/CoordinatorJobBean.java | 8 +- .../org/apache/oozie/CoordinatorJobInfo.java | 8 +- .../main/java/org/apache/oozie/DagEngine.java | 6 +- .../java/org/apache/oozie/FaultInjection.java | 10 +- .../java/org/apache/oozie/LocalOozieClient.java | 16 +- .../org/apache/oozie/LocalOozieClientCoord.java | 20 +-- .../main/java/org/apache/oozie/StringBlob.java | 2 +- .../org/apache/oozie/WorkflowActionBean.java | 17 +- .../java/org/apache/oozie/WorkflowsInfo.java | 6 +- .../main/java/org/apache/oozie/XException.java | 6 +- .../org/apache/oozie/action/ActionExecutor.java | 28 +-- .../oozie/action/ActionExecutorException.java | 4 +- .../control/ControlNodeActionExecutor.java | 4 +- .../oozie/action/hadoop/FsActionExecutor.java | 2 +- .../action/hadoop/HCatCredentialHelper.java | 2 +- .../oozie/action/hadoop/JavaActionExecutor.java | 6 +- .../oozie/action/ssh/SshActionExecutor.java | 2 +- .../oozie/client/rest/BulkResponseImpl.java | 8 +- .../apache/oozie/command/BulkJobsXCommand.java | 2 +- .../command/MaterializeTransitionXCommand.java | 2 +- .../oozie/command/PauseTransitionXCommand.java | 4 +- .../oozie/command/RerunTransitionXCommand.java | 2 +- .../oozie/command/StartTransitionXCommand.java | 2 +- .../oozie/command/SubmitTransitionXCommand.java | 2 +- .../oozie/command/TransitionXCommand.java | 5 +- .../command/UnpauseTransitionXCommand.java | 4 +- .../java/org/apache/oozie/command/XCommand.java | 56 +++--- .../command/bundle/BundleJobsXCommand.java | 2 +- .../command/bundle/BundleRerunXCommand.java | 4 +- .../command/bundle/BundleSubmitXCommand.java | 2 - .../command/coord/CoordActionsKillXCommand.java | 8 +- .../oozie/command/coord/CoordCommandUtils.java | 20 +-- .../oozie/command/coord/CoordRerunXCommand.java | 11 +- .../command/coord/CoordSubmitXCommand.java | 4 +- .../oozie/command/wf/ActionCheckXCommand.java | 2 +- .../apache/oozie/command/wf/ActionXCommand.java | 8 +- .../apache/oozie/command/wf/KillXCommand.java | 2 +- .../apache/oozie/command/wf/ReRunXCommand.java | 3 +- .../apache/oozie/command/wf/SubmitXCommand.java | 1 - .../apache/oozie/coord/CoordELEvaluator.java | 4 +- .../apache/oozie/coord/CoordELFunctions.java | 176 +++++++++---------- .../oozie/coord/CoordinatorJobException.java | 2 +- .../org/apache/oozie/coord/HCatELFunctions.java | 70 ++++---- .../apache/oozie/coord/SyncCoordDataset.java | 2 +- .../org/apache/oozie/dependency/URIHandler.java | 3 - .../java/org/apache/oozie/event/EventQueue.java | 2 +- .../oozie/event/listener/JobEventListener.java | 10 +- .../oozie/executor/jpa/BulkJPAExecutor.java | 3 +- .../jpa/CoordActionRemoveJPAExecutor.java | 2 +- .../apache/oozie/executor/jpa/JPAExecutor.java | 6 +- .../org/apache/oozie/jms/ConnectionContext.java | 3 +- .../java/org/apache/oozie/local/LocalOozie.java | 28 +-- .../service/AbandonedCoordCheckerService.java | 4 +- .../oozie/service/AuthorizationService.java | 24 +-- .../oozie/service/CallableQueueService.java | 26 +-- .../oozie/service/ConfigurationService.java | 20 +-- .../org/apache/oozie/service/ELService.java | 8 +- .../oozie/service/HadoopAccessorService.java | 6 +- .../oozie/service/InstrumentationService.java | 4 +- .../oozie/service/JobsConcurrencyService.java | 2 - .../oozie/service/LiteWorkflowAppService.java | 1 - .../oozie/service/LiteWorkflowStoreService.java | 8 +- .../service/MetricsInstrumentationService.java | 2 +- .../PartitionDependencyManagerService.java | 3 - .../apache/oozie/service/ProxyUserService.java | 6 +- .../apache/oozie/service/SLAStoreService.java | 4 +- .../apache/oozie/service/SchedulerService.java | 6 +- .../java/org/apache/oozie/service/Service.java | 6 +- .../java/org/apache/oozie/service/Services.java | 22 +-- .../apache/oozie/service/ShareLibService.java | 4 +- .../oozie/service/StatusTransitService.java | 4 +- .../org/apache/oozie/service/UUIDService.java | 9 +- .../oozie/service/WorkflowAppService.java | 2 +- .../oozie/service/WorkflowStoreService.java | 4 +- .../org/apache/oozie/service/XLogService.java | 16 +- .../org/apache/oozie/service/ZKUUIDService.java | 1 - .../org/apache/oozie/servlet/AuthFilter.java | 4 +- .../apache/oozie/servlet/BaseJobServlet.java | 4 +- .../apache/oozie/servlet/HostnameFilter.java | 6 +- .../apache/oozie/servlet/JsonRestServlet.java | 6 +- .../apache/oozie/servlet/V1AdminServlet.java | 2 +- .../apache/oozie/servlet/XServletException.java | 2 +- .../org/apache/oozie/sla/SLACalcStatus.java | 3 +- .../org/apache/oozie/sla/SLACalculator.java | 4 +- .../oozie/sla/listener/SLAEventListener.java | 12 +- .../apache/oozie/sla/service/SLAService.java | 10 +- .../java/org/apache/oozie/store/SLAStore.java | 4 +- .../main/java/org/apache/oozie/store/Store.java | 2 +- .../org/apache/oozie/store/WorkflowStore.java | 1 - .../oozie/test/EmbeddedServletContainer.java | 6 +- .../java/org/apache/oozie/util/ClassUtils.java | 2 +- .../java/org/apache/oozie/util/DateUtils.java | 6 +- .../apache/oozie/util/ELConstantsFunctions.java | 2 +- .../java/org/apache/oozie/util/ELEvaluator.java | 30 ++-- .../java/org/apache/oozie/util/IOUtils.java | 10 +- .../org/apache/oozie/util/Instrumentation.java | 40 ++--- .../java/org/apache/oozie/util/JobUtils.java | 4 +- .../oozie/util/MetricsInstrumentation.java | 8 +- .../org/apache/oozie/util/ParamChecker.java | 14 +- .../apache/oozie/util/ParameterVerifier.java | 2 +- .../oozie/util/ParameterVerifierException.java | 2 +- .../oozie/util/PollablePriorityDelayQueue.java | 4 +- .../apache/oozie/util/PriorityDelayQueue.java | 58 +++--- .../org/apache/oozie/util/WritableUtils.java | 4 +- .../java/org/apache/oozie/util/XCallable.java | 8 +- .../org/apache/oozie/util/XConfiguration.java | 10 +- .../main/java/org/apache/oozie/util/XLog.java | 16 +- .../apache/oozie/util/XLogUserFilterParam.java | 2 +- .../java/org/apache/oozie/util/XmlUtils.java | 12 +- .../java/org/apache/oozie/util/ZKUtils.java | 2 +- .../apache/oozie/workflow/WorkflowInstance.java | 14 +- .../org/apache/oozie/workflow/WorkflowLib.java | 2 +- .../oozie/workflow/lite/DBLiteWorkflowLib.java | 1 - .../oozie/workflow/lite/StartNodeDef.java | 4 +- pom.xml | 2 +- release-log.txt | 1 + 130 files changed, 621 insertions(+), 659 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/cli/OozieCLI.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/cli/OozieCLI.java b/client/src/main/java/org/apache/oozie/cli/OozieCLI.java index aa7ad6c..c381432 100644 --- a/client/src/main/java/org/apache/oozie/cli/OozieCLI.java +++ b/client/src/main/java/org/apache/oozie/cli/OozieCLI.java @@ -213,7 +213,7 @@ public class OozieCLI { /** * Entry point for the Oozie CLI when invoked from the command line. - * <p/> + * <p> * Upon completion this method exits the JVM with '0' (success) or '-1' (failure). * * @param args options and arguments for the Oozie CLI. @@ -594,9 +594,9 @@ public class OozieCLI { /** * Run a CLI programmatically. - * <p/> + * <p> * It does not exit the JVM. - * <p/> + * <p> * A CLI instance can be used only once. * * @param args options and arguments for the Oozie CLI. @@ -887,7 +887,7 @@ public class OozieCLI { /** * Create a OozieClient. - * <p/> + * <p> * It injects any '-Dheader:' as header to the the {@link org.apache.oozie.client.OozieClient}. * * @param commandLine the parsed command line options. @@ -900,7 +900,7 @@ public class OozieCLI { /** * Create a XOozieClient. - * <p/> + * <p> * It injects any '-Dheader:' as header to the the {@link org.apache.oozie.client.OozieClient}. * * @param commandLine the parsed command line options. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/AuthOozieClient.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/AuthOozieClient.java b/client/src/main/java/org/apache/oozie/client/AuthOozieClient.java index eb1792b..b62887b 100644 --- a/client/src/main/java/org/apache/oozie/client/AuthOozieClient.java +++ b/client/src/main/java/org/apache/oozie/client/AuthOozieClient.java @@ -53,7 +53,7 @@ public class AuthOozieClient extends XOozieClient { /** * File constant that defines the location of the authentication token cache file. - * <p/> + * <p> * It resolves to <code>${user.home}/.oozie-auth-token</code>. */ public static final File AUTH_TOKEN_CACHE_FILE = new File(System.getProperty("user.home"), ".oozie-auth-token"); @@ -86,10 +86,10 @@ public class AuthOozieClient extends XOozieClient { /** * Create an authenticated connection to the Oozie server. - * <p/> + * <p> * It uses Hadoop-auth client authentication which by default supports * Kerberos HTTP SPNEGO, Pseudo/Simple and anonymous. - * <p/> + * <p> * if the Java system property {@link #USE_AUTH_TOKEN_CACHE_SYS_PROP} is set to true Hadoop-auth * authentication token will be cached/used in/from the '.oozie-auth-token' file in the user * home directory. @@ -146,7 +146,7 @@ public class AuthOozieClient extends XOozieClient { /** * Read a authentication token cached in the user home directory. - * <p/> + * <p> * * @return the authentication token cached in the user home directory, NULL if none. */ @@ -170,9 +170,9 @@ public class AuthOozieClient extends XOozieClient { /** * Write the current authentication token to the user home directory.authOption - * <p/> + * <p> * The file is written with user only read/write permissions. - * <p/> + * <p> * If the file cannot be updated or the user only ready/write permissions cannot be set the file is deleted. * * @param authToken the authentication token to cache. @@ -197,10 +197,10 @@ public class AuthOozieClient extends XOozieClient { /** * Return the Hadoop-auth Authenticator to use. - * <p/> + * <p> * It first looks for value of command line option 'auth', if not set it continues to check * {@link #AUTHENTICATOR_CLASS_SYS_PROP} Java system property for Authenticator. - * <p/> + * <p> * It the value of the {@link #AUTHENTICATOR_CLASS_SYS_PROP} is not set it uses * Hadoop-auth <code>KerberosAuthenticator</code> which supports both Kerberos HTTP SPNEGO and Pseudo/simple * authentication. @@ -263,12 +263,11 @@ public class AuthOozieClient extends XOozieClient { /** * Get the map for classes of Authenticator. * Default values are: - * null -> KerberosAuthenticator - * SIMPLE -> PseudoAuthenticator - * KERBEROS -> KerberosAuthenticator + * null : KerberosAuthenticator + * SIMPLE : PseudoAuthenticator + * KERBEROS : KerberosAuthenticator * * @return the map for classes of Authenticator - * @throws OozieClientException */ protected Map<String, Class<? extends Authenticator>> getAuthenticators() { Map<String, Class<? extends Authenticator>> authClasses = new HashMap<String, Class<? extends Authenticator>>(); http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/CoordinatorJob.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/CoordinatorJob.java b/client/src/main/java/org/apache/oozie/client/CoordinatorJob.java index 2ded30e..5123695 100644 --- a/client/src/main/java/org/apache/oozie/client/CoordinatorJob.java +++ b/client/src/main/java/org/apache/oozie/client/CoordinatorJob.java @@ -154,7 +154,7 @@ public interface CoordinatorJob extends Job { /** * Return the application group. - * <p/> + * <p> * Use the {@link #getAcl()} method instead. * * @return the application group. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/OozieClient.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/OozieClient.java b/client/src/main/java/org/apache/oozie/client/OozieClient.java index db21e9e..6b7e750 100644 --- a/client/src/main/java/org/apache/oozie/client/OozieClient.java +++ b/client/src/main/java/org/apache/oozie/client/OozieClient.java @@ -59,21 +59,21 @@ import java.util.concurrent.Callable; /** * Client API to submit and manage Oozie workflow jobs against an Oozie intance. - * <p/> + * <p> * This class is thread safe. - * <p/> + * <p> * Syntax for filter for the {@link #getJobsInfo(String)} {@link #getJobsInfo(String, int, int)} methods: * <code>[NAME=VALUE][;NAME=VALUE]*</code>. - * <p/> + * <p> * Valid filter names are: - * <p/> - * <ul/> + * <p> + * <ul> * <li>name: the workflow application name from the workflow definition.</li> * <li>user: the user that submitted the job.</li> * <li>group: the group for the job.</li> * <li>status: the status of the job.</li> * </ul> - * <p/> + * <p> * The query will do an AND among all the filter names. The query will do an OR among all the filter values for the same * name. Multiple values must be specified as different name value pairs. */ @@ -209,7 +209,7 @@ public class OozieClient { } /** - * debugMode =0 means no debugging. > 0 means debugging on. + * debugMode =0 means no debugging. 1 means debugging on. */ public int debugMode = 0; @@ -227,7 +227,7 @@ public class OozieClient { /** * Allows to impersonate other users in the Oozie server. The current user * must be configured as a proxyuser in Oozie. - * <p/> + * <p> * IMPORTANT: impersonation happens only with Oozie client requests done within * doAs() calls. * @@ -265,7 +265,7 @@ public class OozieClient { /** * Return the Oozie URL of the workflow client instance. - * <p/> + * <p> * This URL is the base URL fo the Oozie system, with not protocol versioning. * * @return the Oozie URL of the workflow client instance. @@ -276,7 +276,7 @@ public class OozieClient { /** * Return the Oozie URL used by the client and server for WS communications. - * <p/> + * <p> * This URL is the original URL plus the versioning element path. * * @return the Oozie URL used by the client and server for communication. @@ -297,7 +297,7 @@ public class OozieClient { /** * Set debug mode. * - * @param debugMode : 0 means no debugging. > 0 means debugging + * @param debugMode : 0 means no debugging. 1 means debugging */ public void setDebugMode(int debugMode) { this.debugMode = debugMode; @@ -498,7 +498,6 @@ public class OozieClient { * @param method * @return connection * @throws IOException - * @throws OozieClientException */ protected HttpURLConnection createRetryableConnection(final URL url, final String method) throws IOException{ return (HttpURLConnection) new ConnectionRetriableClient(getRetryCount()) { @@ -1259,7 +1258,7 @@ public class OozieClient { /** * Return a reader as string. - * <p/> + * <p> * * @param reader reader to read into a string. * @param maxLen max content length allowed, if -1 there is no limit. @@ -1714,7 +1713,7 @@ public class OozieClient { /** * Return the info of the workflow jobs that match the filter. - * <p/> + * <p> * It returns the first 100 jobs that match the filter. * * @param filter job filter. Refer to the {@link OozieClient} for the filter syntax. @@ -1729,7 +1728,7 @@ public class OozieClient { * Sla enable alert. * * @param jobIds the job ids - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @throws OozieClientException the oozie client exception */ @@ -1741,7 +1740,7 @@ public class OozieClient { * Sla enable alert for bundle with coord name/id. * * @param bundleId the bundle id - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @param coords the coordinators * @throws OozieClientException the oozie client exception @@ -1755,7 +1754,7 @@ public class OozieClient { * Sla disable alert. * * @param jobIds the job ids - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @throws OozieClientException the oozie client exception */ @@ -1767,7 +1766,7 @@ public class OozieClient { * Sla disable alert for bundle with coord name/id. * * @param bundleId the bundle id - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @param coords the coordinators * @throws OozieClientException the oozie client exception @@ -1779,10 +1778,10 @@ public class OozieClient { /** * Sla change definations. - * SLA change definition parameters can be [<key>=<value>,...<key>=<value>] + * SLA change definition parameters can be [<key>=<value>,...<key>=<value>] * Supported parameter key names are should-start, should-end and max-duration * @param jobIds the job ids - * @param actionIds comma separated list of action ids or action id ranges. + * @param actions comma separated list of action ids or action id ranges. * @param dates comma separated list of the nominal times * @param newSlaParams the new sla params * @throws OozieClientException the oozie client exception @@ -1793,10 +1792,10 @@ public class OozieClient { /** * Sla change defination for bundle with coord name/id. - * SLA change definition parameters can be [<key>=<value>,...<key>=<value>] + * SLA change definition parameters can be [<key>=<value>,...<key>=<value>] * Supported parameter key names are should-start, should-end and max-duration * @param bundleId the bundle id - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @param coords the coords * @param newSlaParams the new sla params @@ -1811,7 +1810,7 @@ public class OozieClient { * Sla change with new sla param as hasmap. * Supported parameter key names are should-start, should-end and max-duration * @param bundleId the bundle id - * @param actionIds comma separated list of action ids or action id ranges + * @param actions comma separated list of action ids or action id ranges * @param dates comma separated list of the nominal times * @param coords the coords * @param newSlaParams the new sla params @@ -1924,7 +1923,7 @@ public class OozieClient { /** * Return the workflow job Id for an external Id. - * <p/> + * <p> * The external Id must have provided at job creation time. * * @param externalId external Id given at job creation time. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/WorkflowJob.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/WorkflowJob.java b/client/src/main/java/org/apache/oozie/client/WorkflowJob.java index 1af9c8b..e2ad6f2 100644 --- a/client/src/main/java/org/apache/oozie/client/WorkflowJob.java +++ b/client/src/main/java/org/apache/oozie/client/WorkflowJob.java @@ -107,7 +107,7 @@ public interface WorkflowJob { /** * Return the workflow job group. - * <p/> + * <p> * Use the {@link #getAcl()} method instead. * * @return the workflow job group. @@ -123,7 +123,7 @@ public interface WorkflowJob { String getAcl(); /** - * Return the workflow job run number. <p/> Except for reruns, this property is always 1. + * Return the workflow job run number. <p> Except for reruns, this property is always 1. * * @return the workflow job run number. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/XOozieClient.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/XOozieClient.java b/client/src/main/java/org/apache/oozie/client/XOozieClient.java index 43c1238..8ee9c57 100644 --- a/client/src/main/java/org/apache/oozie/client/XOozieClient.java +++ b/client/src/main/java/org/apache/oozie/client/XOozieClient.java @@ -313,7 +313,7 @@ public class XOozieClient extends OozieClient { } /** - * The equivalent to <file> tag in oozie's workflow xml. + * The equivalent to <file> tag in oozie's workflow xml. * * @param conf Configuration object. * @param file file HDFS path. A "#..." symbolic string can be appended to the path to specify symbolic link name. @@ -329,7 +329,7 @@ public class XOozieClient extends OozieClient { } /** - * The equivalent to <archive> tag in oozie's workflow xml. + * The equivalent to <archive> tag in oozie's workflow xml. * * @param conf Configuration object. * @param file file HDFS path. A "#..." symbolic string can be appended to the path to specify symbolic link name. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/rest/JsonToBean.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/rest/JsonToBean.java b/client/src/main/java/org/apache/oozie/client/rest/JsonToBean.java index d6aa43e..4c65392 100644 --- a/client/src/main/java/org/apache/oozie/client/rest/JsonToBean.java +++ b/client/src/main/java/org/apache/oozie/client/rest/JsonToBean.java @@ -46,7 +46,7 @@ import java.util.Set; /** * JSON to bean converter for {@link WorkflowAction}, {@link WorkflowJob}, {@link CoordinatorAction} * and {@link CoordinatorJob}. - * <p/> + * <p> * It uses JDK dynamic proxy to create bean instances. */ @SuppressWarnings("rawtypes") http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/client/src/main/java/org/apache/oozie/client/rest/JsonUtils.java ---------------------------------------------------------------------- diff --git a/client/src/main/java/org/apache/oozie/client/rest/JsonUtils.java b/client/src/main/java/org/apache/oozie/client/rest/JsonUtils.java index 2f0cc63..74e485c 100644 --- a/client/src/main/java/org/apache/oozie/client/rest/JsonUtils.java +++ b/client/src/main/java/org/apache/oozie/client/rest/JsonUtils.java @@ -40,7 +40,7 @@ public class JsonUtils { * * @param date date to format. * @param timeZoneId the time zone to use - * @return RFC822 for the date, <code>null</code> if the date was <code>null</null>. + * @return RFC822 for the date, <code>null</code> if the date was <code>null</code>. */ public static String formatDateRfc822(Date date, String timeZoneId) { if (date != null) { @@ -56,7 +56,7 @@ public class JsonUtils { * Format a Date in RFC822 GMT. * * @param date date to format. - * @return RFC822 GMT for the date, <code>null</code> if the date was <code>null</null>. + * @return RFC822 GMT for the date, <code>null</code> if the date was <code>null</code>. */ public static String formatDateRfc822(Date date) { return formatDateRfc822(date, "GMT"); @@ -66,7 +66,7 @@ public class JsonUtils { * Parse a string in RFC822 GMT format. * * @param str string to parse. - * @return parsed date, <code>null</code> if the string was <code>null</null> or in an invalid format. + * @return parsed date, <code>null</code> if the string was <code>null</code> or in an invalid format. */ static Date parseDateRfc822(String str) { if (str != null) { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/BaseEngine.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BaseEngine.java b/core/src/main/java/org/apache/oozie/BaseEngine.java index 4ea87c0..50df897 100644 --- a/core/src/main/java/org/apache/oozie/BaseEngine.java +++ b/core/src/main/java/org/apache/oozie/BaseEngine.java @@ -52,7 +52,7 @@ public abstract class BaseEngine { /** * Submit a job. - * <p/> + * <p> * It validates configuration properties. * * @param conf job configuration. @@ -148,7 +148,7 @@ public abstract class BaseEngine { * @param filter the status filter * @param start starting from this index in the list of actions belonging to the job * @param length number of actions to be returned - * @param order true if actions are sorted in a descending order of nominal time, false if asc order + * @param desc true if actions are sorted in a descending order of nominal time, false if asc order * @return the coord job info. * @throws BaseEngineException thrown if the job info could not be obtained. */ @@ -205,7 +205,7 @@ public abstract class BaseEngine { /** * Return the workflow Job ID for an external ID. - * <p/> + * <p> * This is reverse lookup for recovery purposes. * * @param externalId external ID provided at job submission time. @@ -215,9 +215,9 @@ public abstract class BaseEngine { public abstract String getJobIdForExternalId(String externalId) throws BaseEngineException; /** - * Dry run a job; like {@link BaseEngine#submitJob(org.apache.hadoop.conf.Configuration, boolean) but doesn't actually execute + * Dry run a job; like {@link BaseEngine#submitJob(org.apache.hadoop.conf.Configuration, boolean)} but doesn't actually execute * the job. - * <p/> + * <p> * It validates configuration properties. * * @param conf job configuration. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/BulkResponseInfo.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BulkResponseInfo.java b/core/src/main/java/org/apache/oozie/BulkResponseInfo.java index 333102f..526c412 100644 --- a/core/src/main/java/org/apache/oozie/BulkResponseInfo.java +++ b/core/src/main/java/org/apache/oozie/BulkResponseInfo.java @@ -36,7 +36,7 @@ public class BulkResponseInfo { /** * Create a bulk response info bean. * - * @param bundle job being returned. + * @param responses jobs being returned. * @param start bulk entries offset. * @param len number of bulk entries. * @param total total bulk entries. @@ -59,7 +59,7 @@ public class BulkResponseInfo { /** * Return the offset of the bulk entries being returned. - * <p/> + * <p> * For pagination purposes. * * @return the offset of the bulk entries being returned. @@ -70,7 +70,7 @@ public class BulkResponseInfo { /** * Return the number of the bulk entries being returned. - * <p/> + * <p> * For pagination purposes. * * @return the number of the bulk entries being returned. @@ -81,7 +81,7 @@ public class BulkResponseInfo { /** * Return the total number of bulk entries. - * <p/> + * <p> * For pagination purposes. * * @return the total number of bulk entries. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/BundleActionBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BundleActionBean.java b/core/src/main/java/org/apache/oozie/BundleActionBean.java index 56e3672..ccc18d9 100644 --- a/core/src/main/java/org/apache/oozie/BundleActionBean.java +++ b/core/src/main/java/org/apache/oozie/BundleActionBean.java @@ -204,7 +204,7 @@ public class BundleActionBean implements Writable, JsonBean { /** * Set the Status of the Bundle Action * - * @return status string + * @param statusStr status string */ public void setStatusStr(String statusStr) { this.statusStr = statusStr; @@ -220,18 +220,14 @@ public class BundleActionBean implements Writable, JsonBean { } /** - * Set Whether this bundle action is critical or not. - * - * @param critical set critical to true + * Set that this bundle action is critical. */ public void setCritical() { this.critical = 1; } /** - * Reseset Whether this bundle action is critical or not. - * - * @param critical set critical to false + * Reseset that this bundle action is not critical. */ public void resetCritical() { this.critical = 0; http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/BundleJobBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BundleJobBean.java b/core/src/main/java/org/apache/oozie/BundleJobBean.java index e45791e..9b31bd3 100644 --- a/core/src/main/java/org/apache/oozie/BundleJobBean.java +++ b/core/src/main/java/org/apache/oozie/BundleJobBean.java @@ -310,8 +310,6 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { /** * Set pending to true - * - * @param pending set pending to true */ @Override public void setPending() { @@ -323,14 +321,12 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { * * @param pending set pending value */ - public void setPending(int i) { - this.pending = i; + public void setPending(int pending) { + this.pending = pending; } /** * Set pending to false - * - * @param pending set pending to false */ @Override public void resetPending() { @@ -530,7 +526,7 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { } /** - * @param return the suspendTime + * @param suspendTime the suspendTime */ public void setSuspendedTime(Date suspendTime) { this.suspendedTimestamp = DateUtils.convertDateToTimestamp(suspendTime); @@ -704,7 +700,7 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { /** * Set status * - * @param status the status to set + * @param statusStr the status to set */ public void setStatus(String statusStr) { this.statusStr = statusStr; @@ -776,7 +772,7 @@ public class BundleJobBean implements Writable, BundleJob, JsonBean { /** * Convert a Bundle job list into a JSONArray. * - * @param application list. + * @param applications list of applications. * @param timeZoneId time zone to use for dates in the JSON array. * @return the corresponding JSON array. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/BundleJobInfo.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/BundleJobInfo.java b/core/src/main/java/org/apache/oozie/BundleJobInfo.java index 9de10fb..9b9b50f 100644 --- a/core/src/main/java/org/apache/oozie/BundleJobInfo.java +++ b/core/src/main/java/org/apache/oozie/BundleJobInfo.java @@ -29,7 +29,7 @@ public class BundleJobInfo { /** * Create a bundle info bean. * - * @param bundle jobs being returned. + * @param jobs jobs being returned. * @param start bundle jobs offset. * @param len number of bundle jobs. * @param total total bundle jobs. @@ -52,7 +52,7 @@ public class BundleJobInfo { /** * Return the offset of the bundles being returned. - * <p/> + * <p> * For pagination purposes. * * @return the offset of the bundle jobs being returned. @@ -63,7 +63,7 @@ public class BundleJobInfo { /** * Return the number of the bundle being returned. - * <p/> + * <p> * For pagination purposes. * * @return the number of the bundle jobs being returned. @@ -74,7 +74,7 @@ public class BundleJobInfo { /** * Return the total number of bundles. - * <p/> + * <p> * For pagination purposes. * * @return the total number of bundle jobs. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/CoordinatorActionInfo.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/CoordinatorActionInfo.java b/core/src/main/java/org/apache/oozie/CoordinatorActionInfo.java index 417d937..541a824 100644 --- a/core/src/main/java/org/apache/oozie/CoordinatorActionInfo.java +++ b/core/src/main/java/org/apache/oozie/CoordinatorActionInfo.java @@ -26,7 +26,7 @@ public class CoordinatorActionInfo { /** * Create a coordiantor actions info bean. * - * @param coordiantor actions being returned. + * @param actions actions being returned. */ public CoordinatorActionInfo(List<CoordinatorActionBean> actions) { this.actions = actions; http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java b/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java index c3ee839..3ec2eaf 100644 --- a/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java +++ b/core/src/main/java/org/apache/oozie/CoordinatorJobBean.java @@ -684,9 +684,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { } /** - * Get status - * - * @return status + * Set status */ public void setStatusStr(String status) { this.statusStr = status; @@ -744,9 +742,7 @@ public class CoordinatorJobBean implements Writable, CoordinatorJob, JsonBean { } /** - * Get execution - * - * @return execution + * Set execution order */ public void setExecution(String order) { this.execution = order; http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/CoordinatorJobInfo.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/CoordinatorJobInfo.java b/core/src/main/java/org/apache/oozie/CoordinatorJobInfo.java index 02db786..04c5bc9 100644 --- a/core/src/main/java/org/apache/oozie/CoordinatorJobInfo.java +++ b/core/src/main/java/org/apache/oozie/CoordinatorJobInfo.java @@ -29,7 +29,7 @@ public class CoordinatorJobInfo { /** * Create a coordinator info bean. * - * @param coordiantor jobs being returned. + * @param jobs jobs being returned. * @param start coordiantor jobs offset. * @param len number of coordiantor jobs. * @param total total coordiantor jobs. @@ -51,7 +51,7 @@ public class CoordinatorJobInfo { } /** - * Return the offset of the workflows being returned. <p/> For pagination purposes. + * Return the offset of the workflows being returned. <p> For pagination purposes. * * @return the offset of the coordiantor jobs being returned. */ @@ -60,7 +60,7 @@ public class CoordinatorJobInfo { } /** - * Return the number of the workflows being returned. <p/> For pagination purposes. + * Return the number of the workflows being returned. <p> For pagination purposes. * * @return the number of the coordiantor jobs being returned. */ @@ -69,7 +69,7 @@ public class CoordinatorJobInfo { } /** - * Return the total number of workflows. <p/> For pagination purposes. + * Return the total number of workflows. <p> For pagination purposes. * * @return the total number of coordiantor jobs. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/DagEngine.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/DagEngine.java b/core/src/main/java/org/apache/oozie/DagEngine.java index 3d09206..9061d17 100644 --- a/core/src/main/java/org/apache/oozie/DagEngine.java +++ b/core/src/main/java/org/apache/oozie/DagEngine.java @@ -98,7 +98,7 @@ public class DagEngine extends BaseEngine { } /** - * Submit a workflow job. <p/> It validates configuration properties. + * Submit a workflow job. <p> It validates configuration properties. * * @param conf job configuration. * @param startJob indicates if the job should be started or not. @@ -146,7 +146,7 @@ public class DagEngine extends BaseEngine { /** * Submit a pig/hive/mapreduce job through HTTP. - * <p/> + * <p> * It validates configuration properties. * * @param conf job configuration. @@ -544,7 +544,7 @@ public class DagEngine extends BaseEngine { } /** - * Return the workflow Job ID for an external ID. <p/> This is reverse lookup for recovery purposes. + * Return the workflow Job ID for an external ID. <p> This is reverse lookup for recovery purposes. * * @param externalId external ID provided at job submission time. * @return the associated workflow job ID if any, <code>null</code> if none. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/FaultInjection.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/FaultInjection.java b/core/src/main/java/org/apache/oozie/FaultInjection.java index 1eab8df..5cae3fa 100644 --- a/core/src/main/java/org/apache/oozie/FaultInjection.java +++ b/core/src/main/java/org/apache/oozie/FaultInjection.java @@ -21,12 +21,12 @@ package org.apache.oozie; import org.apache.oozie.util.XLog; /** - * Fault Injection support class. <p/> Concrete classes should be available only during testing, not in production. <p/> - * To activate fault injection the {@link #FAULT_INJECTION} system property must be set to true. <p/> When fault - * injection is activated, the concrete class (specified by name) will be call for activation. <p/> Concrete classes - * should be activated by presense of a second system property. <p/> This fault injection pattern provides 3 levels of + * Fault Injection support class. <p> Concrete classes should be available only during testing, not in production. <p> + * To activate fault injection the {@link #FAULT_INJECTION} system property must be set to true. <p> When fault + * injection is activated, the concrete class (specified by name) will be call for activation. <p> Concrete classes + * should be activated by presense of a second system property. <p> This fault injection pattern provides 3 levels of * safeguard: a general 'fault injection' system property, the availabity of of the concrete 'fault injection' class in - * the classpath, a specifi 'fault injection' system property. <p/> Refer to the <code>SkipCommitFaultInjection</code> + * the classpath, a specifi 'fault injection' system property. <p> Refer to the <code>SkipCommitFaultInjection</code> * class in the test classes for an example. */ public abstract class FaultInjection { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/LocalOozieClient.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/LocalOozieClient.java b/core/src/main/java/org/apache/oozie/LocalOozieClient.java index ee86928..f734f76 100644 --- a/core/src/main/java/org/apache/oozie/LocalOozieClient.java +++ b/core/src/main/java/org/apache/oozie/LocalOozieClient.java @@ -29,11 +29,11 @@ import org.apache.oozie.client.WorkflowJob; import org.apache.oozie.util.XConfiguration; /** - * Client API to submit and manage Oozie workflow jobs against an Oozie intance. <p/> This class is thread safe. <p/> + * Client API to submit and manage Oozie workflow jobs against an Oozie intance. <p> This class is thread safe. <p> * Syntax for filter for the {@link #getJobsInfo(String)} {@link #getJobsInfo(String, int, int)} methods: - * <code>[NAME=VALUE][;NAME=VALUE]*</code>. <p/> Valid filter names are: <p/> <ul/> <li>name: the workflow application + * <code>[NAME=VALUE][;NAME=VALUE]*</code>. <p> Valid filter names are: <p> <ul> <li>name: the workflow application * name from the workflow definition.</li> <li>user: the user that submitted the job.</li> <li>group: the group for the - * job.</li> <li>status: the status of the job.</li> </ul> <p/> The query will do an AND among all the filter names. The + * job.</li> <li>status: the status of the job.</li> </ul> <p> The query will do an AND among all the filter names. The * query will do an OR among all the filter values for the same name. Multiple values must be specified as different * name value pairs. */ @@ -42,7 +42,7 @@ public class LocalOozieClient extends OozieClient { private DagEngine dagEngine; /** - * Create a workflow client for Oozie local use. <p/> + * Create a workflow client for Oozie local use. <p> * * @param dagEngine the dag engine instance to use. */ @@ -51,7 +51,7 @@ public class LocalOozieClient extends OozieClient { } /** - * Return the Oozie URL of the workflow client instance. <p/> This URL is the base URL fo the Oozie system, with not + * Return the Oozie URL of the workflow client instance. <p> This URL is the base URL fo the Oozie system, with not * protocol versioning. * * @return the Oozie URL of the workflow client instance. @@ -62,7 +62,7 @@ public class LocalOozieClient extends OozieClient { } /** - * Return the Oozie URL used by the client and server for WS communications. <p/> This URL is the original URL plus + * Return the Oozie URL used by the client and server for WS communications. <p> This URL is the original URL plus * the versioning element path. * * @return the Oozie URL used by the client and server for communication. @@ -294,7 +294,7 @@ public class LocalOozieClient extends OozieClient { } /** - * Return the info of the workflow jobs that match the filter. <p/> It returns the first 100 jobs that match the + * Return the info of the workflow jobs that match the filter. <p> It returns the first 100 jobs that match the * filter. * * @param filter job filter. Refer to the {@link LocalOozieClient} for the filter syntax. @@ -307,7 +307,7 @@ public class LocalOozieClient extends OozieClient { } /** - * Return the workflow job Id for an external Id. <p/> The external Id must have provided at job creation time. + * Return the workflow job Id for an external Id. <p> The external Id must have provided at job creation time. * * @param externalId external Id given at job creation time. * @return the workflow job Id for an external Id, <code>null</code> if none. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java b/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java index 0932e6c..cf60c37 100644 --- a/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java +++ b/core/src/main/java/org/apache/oozie/LocalOozieClientCoord.java @@ -37,22 +37,22 @@ import org.apache.oozie.util.XConfiguration; /** * Client API to submit and manage Oozie coordinator jobs against an Oozie * intance. - * <p/> + * <p> * This class is thread safe. - * <p/> + * <p> * Syntax for filter for the {@link #getJobsInfo(String)} * {@link #getJobsInfo(String, int, int)} methods: * <code>[NAME=VALUE][;NAME=VALUE]*</code>. - * <p/> + * <p> * Valid filter names are: - * <p/> - * <ul/> + * <p> + * <ul> * <li>name: the coordinator application name from the coordinator definition.</li> * <li>user: the user that submitted the job.</li> * <li>group: the group for the job.</li> * <li>status: the status of the job.</li> * </ul> - * <p/> + * <p> * The query will do an AND among all the filter names. The query will do an OR * among all the filter values for the same name. Multiple values must be * specified as different name value pairs. @@ -63,7 +63,7 @@ public class LocalOozieClientCoord extends OozieClient { /** * Create a coordinator client for Oozie local use. - * <p/> + * <p> * * @param coordEngine the engine instance to use. */ @@ -73,7 +73,7 @@ public class LocalOozieClientCoord extends OozieClient { /** * Return the Oozie URL of the coordinator client instance. - * <p/> + * <p> * This URL is the base URL fo the Oozie system, with not protocol * versioning. * @@ -86,7 +86,7 @@ public class LocalOozieClientCoord extends OozieClient { /** * Return the Oozie URL used by the client and server for WS communications. - * <p/> + * <p> * This URL is the original URL plus the versioning element path. * * @return the Oozie URL used by the client and server for communication. @@ -463,7 +463,7 @@ public class LocalOozieClientCoord extends OozieClient { /** * Return the info of the workflow jobs that match the filter. - * <p/> + * <p> * It returns the first 100 jobs that match the filter. * * @param filter job filter. Refer to the {@link LocalOozieClient} for the http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/StringBlob.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/StringBlob.java b/core/src/main/java/org/apache/oozie/StringBlob.java index 4de6549..9e8d383 100644 --- a/core/src/main/java/org/apache/oozie/StringBlob.java +++ b/core/src/main/java/org/apache/oozie/StringBlob.java @@ -46,7 +46,7 @@ public class StringBlob { /** * Construct StringBlob with uncompressed string * - * @param string + * @param inputString */ public StringBlob(String inputString) { this.string = inputString; http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/WorkflowActionBean.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/WorkflowActionBean.java b/core/src/main/java/org/apache/oozie/WorkflowActionBean.java index 7f00278..57ae3f5 100644 --- a/core/src/main/java/org/apache/oozie/WorkflowActionBean.java +++ b/core/src/main/java/org/apache/oozie/WorkflowActionBean.java @@ -493,7 +493,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set a tracking information for an action, and set the action status to - * {@link Action.Status#DONE} + * {@link org.apache.oozie.client.WorkflowAction.Status#DONE} * * @param externalId external ID for the action. * @param trackerUri tracker URI for the action. @@ -513,7 +513,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set the completion information for an action start. Sets the Action - * status to {@link Action.Status#DONE} + * status to {@link org.apache.oozie.client.WorkflowAction.Status#DONE} * * @param externalStatus action external end status. * @param actionData action output data, <code>null</code> if there is no @@ -539,7 +539,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set the action statistics info for the workflow action. * - * @param Json representation of the stats. + * @param jsonStats representation of the stats. */ public void setExecutionStats(String jsonStats) { setStats(jsonStats); @@ -572,7 +572,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set external child ids * - * @param externalChildIds + * @param externalChildIDs */ public void setExternalChildIDsBlob(StringBlob externalChildIDs) { this.externalChildIDs = externalChildIDs; @@ -590,8 +590,9 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set the completion information for an action end. * - * @param status action status, {@link Action.Status#OK} or - * {@link Action.Status#ERROR} or {@link Action.Status#KILLED} + * @param status action status, {@link org.apache.oozie.client.WorkflowAction.Status#OK} or + * {@link org.apache.oozie.client.WorkflowAction.Status#ERROR} or + * {@link org.apache.oozie.client.WorkflowAction.Status#KILLED} * @param signalValue the signal value. In most cases, the value should be * OK or ERROR. */ @@ -707,7 +708,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Return the signal value for the action. - * <p/> + * <p> * For decision nodes it is the choosen transition, for actions it is OK or * ERROR. * @@ -719,7 +720,7 @@ public class WorkflowActionBean implements Writable, WorkflowAction, JsonBean { /** * Set the signal value for the action. - * <p/> + * <p> * For decision nodes it is the choosen transition, for actions it is OK or * ERROR. * http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/WorkflowsInfo.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/WorkflowsInfo.java b/core/src/main/java/org/apache/oozie/WorkflowsInfo.java index 941a872..3e883c4 100644 --- a/core/src/main/java/org/apache/oozie/WorkflowsInfo.java +++ b/core/src/main/java/org/apache/oozie/WorkflowsInfo.java @@ -54,7 +54,7 @@ public class WorkflowsInfo { } /** - * Return the offset of the workflows being returned. <p/> For pagination purposes. + * Return the offset of the workflows being returned. <p> For pagination purposes. * * @return the offset of the workflows being returned. */ @@ -63,7 +63,7 @@ public class WorkflowsInfo { } /** - * Return the number of the workflows being returned. <p/> For pagination purposes. + * Return the number of the workflows being returned. <p> For pagination purposes. * * @return the number of the workflows being returned. */ @@ -72,7 +72,7 @@ public class WorkflowsInfo { } /** - * Return the total number of workflows. <p/> For pagination purposes. + * Return the total number of workflows. <p> For pagination purposes. * * @return the total number of workflows. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/XException.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/XException.java b/core/src/main/java/org/apache/oozie/XException.java index c5e83b5..fb1a381 100644 --- a/core/src/main/java/org/apache/oozie/XException.java +++ b/core/src/main/java/org/apache/oozie/XException.java @@ -22,7 +22,7 @@ import org.apache.oozie.util.XLog; import org.apache.oozie.util.ParamChecker; /** - * Base exception for all Oozie exception. <p/> It requires error codes an captures the Log info at exception time. <p/> + * Base exception for all Oozie exception. <p> It requires error codes an captures the Log info at exception time. <p> * Error codes should be modeled in subclasses as Enums. */ public class XException extends Exception { @@ -50,8 +50,8 @@ public class XException extends Exception { } /** - * Create an EXception from an error code plus parameter to create the exception message. <p/> The value of {@link - * ErrorCode#getTemplate} is used as a StringFormat template for the exception message. <p/> If the last parameter + * Create an EXception from an error code plus parameter to create the exception message. <p> The value of {@link + * ErrorCode#getTemplate} is used as a StringFormat template for the exception message. <p> If the last parameter * is an Exception it is used as the exception cause. * * @param errorCode the error code for the exception. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/ActionExecutor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/ActionExecutor.java b/core/src/main/java/org/apache/oozie/action/ActionExecutor.java index ea652f3..07c6d26 100644 --- a/core/src/main/java/org/apache/oozie/action/ActionExecutor.java +++ b/core/src/main/java/org/apache/oozie/action/ActionExecutor.java @@ -41,7 +41,7 @@ import java.util.Properties; import java.util.LinkedHashMap; /** - * Base action executor class. <p/> All the action executors should extend this class. + * Base action executor class. <p> All the action executors should extend this class. */ public abstract class ActionExecutor { @@ -117,7 +117,7 @@ public abstract class ActionExecutor { public ELEvaluator getELEvaluator(); /** - * Set a workflow action variable. <p/> Convenience method that prefixes the variable name with the action name + * Set a workflow action variable. <p> Convenience method that prefixes the variable name with the action name * plus a '.'. * * @param name variable name. @@ -126,7 +126,7 @@ public abstract class ActionExecutor { public void setVar(String name, String value); /** - * Get a workflow action variable. <p/> Convenience method that prefixes the variable name with the action name + * Get a workflow action variable. <p> Convenience method that prefixes the variable name with the action name * plus a '.'. * * @param name variable name. @@ -287,10 +287,10 @@ public abstract class ActionExecutor { } /** - * Invoked once at system initialization time. <p/> It can be used to register error information for the expected + * Invoked once at system initialization time. <p> It can be used to register error information for the expected * exceptions. Exceptions should be register from subclasses to superclasses to ensure proper detection, same thing - * that it is done in a normal catch. <p/> This method should invoke the {@link #registerError} method to register - * all its possible errors. <p/> Subclasses overriding must invoke super. + * that it is done in a normal catch. <p> This method should invoke the {@link #registerError} method to register + * all its possible errors. <p> Subclasses overriding must invoke super. */ public void initActionType() { XLog.getLog(getClass()).trace(" Init Action Type : [{0}]", getType()); @@ -307,7 +307,7 @@ public abstract class ActionExecutor { } /** - * Return the runtime directory of the Oozie instance. <p/> The directory is created under TMP and it is always a + * Return the runtime directory of the Oozie instance. <p> The directory is created under TMP and it is always a * new directory per system initialization. * * @return the runtime directory of the Oozie instance. @@ -317,7 +317,7 @@ public abstract class ActionExecutor { } /** - * Return Oozie configuration. <p/> This is useful for actions that need access to configuration properties. + * Return Oozie configuration. <p> This is useful for actions that need access to configuration properties. * * @return Oozie configuration. */ @@ -419,7 +419,7 @@ public abstract class ActionExecutor { /** * Utility method to handle exceptions in the {@link #start}, {@link #end}, {@link #kill} and {@link #check} methods - * <p/> It uses the error registry to convert exceptions to {@link ActionExecutorException}s. + * <p> It uses the error registry to convert exceptions to {@link ActionExecutorException}s. * * @param ex exception to convert. * @return ActionExecutorException converted exception. @@ -515,7 +515,7 @@ public abstract class ActionExecutor { } /** - * Start an action. <p/> The {@link Context#setStartData} method must be called within this method. <p/> If the + * Start an action. <p> The {@link Context#setStartData} method must be called within this method. <p> If the * action has completed, the {@link Context#setExecutionData} method must be called within this method. * * @param context executor context. @@ -525,7 +525,7 @@ public abstract class ActionExecutor { public abstract void start(Context context, WorkflowAction action) throws ActionExecutorException; /** - * End an action after it has executed. <p/> The {@link Context#setEndData} method must be called within this + * End an action after it has executed. <p> The {@link Context#setEndData} method must be called within this * method. * * @param context executor context. @@ -535,8 +535,8 @@ public abstract class ActionExecutor { public abstract void end(Context context, WorkflowAction action) throws ActionExecutorException; /** - * Check if an action has completed. This method must be implemented by Async Action Executors. <p/> If the action - * has completed, the {@link Context#setExecutionData} method must be called within this method. <p/> If the action + * Check if an action has completed. This method must be implemented by Async Action Executors. <p> If the action + * has completed, the {@link Context#setExecutionData} method must be called within this method. <p> If the action * has not completed, the {@link Context#setExternalStatus} method must be called within this method. * * @param context executor context. @@ -546,7 +546,7 @@ public abstract class ActionExecutor { public abstract void check(Context context, WorkflowAction action) throws ActionExecutorException; /** - * Kill an action. <p/> The {@link Context#setEndData} method must be called within this method. + * Kill an action. <p> The {@link Context#setEndData} method must be called within this method. * * @param context executor context. * @param action the action to kill. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/ActionExecutorException.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/ActionExecutorException.java b/core/src/main/java/org/apache/oozie/action/ActionExecutorException.java index 78de6e6..9bc0e81 100644 --- a/core/src/main/java/org/apache/oozie/action/ActionExecutorException.java +++ b/core/src/main/java/org/apache/oozie/action/ActionExecutorException.java @@ -22,7 +22,7 @@ import org.apache.oozie.util.ParamChecker; import org.apache.oozie.util.XLog; /** - * ActionExecutor exception. <p/> The exception provides information regarding the transient/no-transient/fatal nature + * ActionExecutor exception. <p> The exception provides information regarding the transient/no-transient/fatal nature * of the exception. */ public class ActionExecutorException extends Exception { @@ -73,7 +73,7 @@ public class ActionExecutorException extends Exception { /** * Create an action executor exception. * - * <p/> If the last parameter is an Exception it is used as the exception cause. + * <p> If the last parameter is an Exception it is used as the exception cause. * * @param errorType the error type. * @param errorCode the error code. http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/control/ControlNodeActionExecutor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/control/ControlNodeActionExecutor.java b/core/src/main/java/org/apache/oozie/action/control/ControlNodeActionExecutor.java index 754f985..cc1b610 100644 --- a/core/src/main/java/org/apache/oozie/action/control/ControlNodeActionExecutor.java +++ b/core/src/main/java/org/apache/oozie/action/control/ControlNodeActionExecutor.java @@ -33,10 +33,10 @@ import java.util.List; /** * Base action executor for control nodes: START/END/KILL/FORK/JOIN - * <p/> + * <p> * This action executor, similar to {@link FsActionExecutor}, is completed during the * {@link #start(Context, WorkflowAction)}. - * <p/> + * <p> * By hooking control nodes to an action executor, control nodes get WF action entries in the DB. */ public abstract class ControlNodeActionExecutor extends ActionExecutor { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java index 013846f..b25ac52 100644 --- a/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java +++ b/core/src/main/java/org/apache/oozie/action/hadoop/FsActionExecutor.java @@ -45,7 +45,7 @@ import org.apache.oozie.util.XmlUtils; import org.jdom.Element; /** - * File system action executor. <p/> This executes the file system mkdir, move and delete commands + * File system action executor. <p> This executes the file system mkdir, move and delete commands */ public class FsActionExecutor extends ActionExecutor { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java b/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java index ca12b60..428975e 100644 --- a/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java +++ b/core/src/main/java/org/apache/oozie/action/hadoop/HCatCredentialHelper.java @@ -72,7 +72,7 @@ public class HCatCredentialHelper { /** * Getting the HCat client. - * @param jobConf + * @param launcherJobConf * @param principal * @param server * @return HCatClient http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java b/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java index 7a7d4a7..492ceaf 100644 --- a/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java +++ b/core/src/main/java/org/apache/oozie/action/hadoop/JavaActionExecutor.java @@ -1541,15 +1541,15 @@ public class JavaActionExecutor extends ActionExecutor { /** * Return the sharelib names for the action. - * <p/> + * <p> * If <code>NULL</code> or empty, it means that the action does not use the action * sharelib. - * <p/> + * <p> * If a non-empty string, i.e. <code>foo</code>, it means the action uses the * action sharelib sub-directory <code>foo</code> and all JARs in the sharelib * <code>foo</code> directory will be in the action classpath. Multiple sharelib * sub-directories can be specified as a comma separated list. - * <p/> + * <p> * The resolution is done using the following precedence order: * <ul> * <li><b>action.sharelib.for.#ACTIONTYPE#</b> in the action configuration</li> http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java b/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java index 99288a6..dd9e1c9 100644 --- a/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java +++ b/core/src/main/java/org/apache/oozie/action/ssh/SshActionExecutor.java @@ -46,7 +46,7 @@ import org.jdom.JDOMException; import org.jdom.Namespace; /** - * Ssh action executor. <p/> <ul> <li>Execute the shell commands on the remote host</li> <li>Copies the base and wrapper + * Ssh action executor. <p> <ul> <li>Execute the shell commands on the remote host</li> <li>Copies the base and wrapper * scripts on to the remote location</li> <li>Base script is used to run the command on the remote host</li> <li>Wrapper * script is used to check the status of the submitted command</li> <li>handles the submission failures</li> </ul> */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java b/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java index 138b7d5..fb021bd 100644 --- a/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java +++ b/core/src/main/java/org/apache/oozie/client/rest/BulkResponseImpl.java @@ -110,7 +110,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the bundle comprising this bulk response object - * @param BundleJobBean + * @param bj */ public void setBundle(BundleJobBean bj) { this.bundle = bj; @@ -118,7 +118,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the coordinator comprising this bulk response object - * @param CoordinatorJobBean + * @param cj */ public void setCoordinator(CoordinatorJobBean cj) { this.coordinator = cj; @@ -126,7 +126,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Sets the coord action comprising this bulk response object - * @param CoordinatorActionBean + * @param ca */ public void setAction(CoordinatorActionBean ca) { this.action = ca; @@ -135,7 +135,7 @@ public class BulkResponseImpl implements BulkResponse, JsonBean { /** * Convert a nodes list into a JSONArray. * - * @param actions nodes list. + * @param responses nodes list. * @param timeZoneId time zone to use for dates in the JSON array. * @return the corresponding JSON array. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/BulkJobsXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/BulkJobsXCommand.java b/core/src/main/java/org/apache/oozie/command/BulkJobsXCommand.java index ec53b4d..94a4f3a 100644 --- a/core/src/main/java/org/apache/oozie/command/BulkJobsXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/BulkJobsXCommand.java @@ -44,7 +44,7 @@ public class BulkJobsXCommand extends XCommand<BulkResponseInfo> { * * @param filter the filter string * @param start start location for paging - * @param len total length to get + * @param length total length to get */ public BulkJobsXCommand(Map<String,List<String>> filter, int start, int length) { super("bundle.job.info", "bundle.job.info", 1); http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/MaterializeTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/MaterializeTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/MaterializeTransitionXCommand.java index 684d31e..bf1221d 100644 --- a/core/src/main/java/org/apache/oozie/command/MaterializeTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/MaterializeTransitionXCommand.java @@ -20,7 +20,7 @@ package org.apache.oozie.command; /** * Transition command for materialize the job. The derived class has to override these following functions: - * <p/> + * <p> * loadState() : load the job's and/or actions' state * updateJob() : update job status and attributes * StartChildren() : submit or queue commands to start children http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/PauseTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/PauseTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/PauseTransitionXCommand.java index 96a8d7a..c2d9f83 100644 --- a/core/src/main/java/org/apache/oozie/command/PauseTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/PauseTransitionXCommand.java @@ -23,12 +23,10 @@ import org.apache.oozie.client.Job; /** * Transition command for pause the job. The derived class has to override these following functions: - * <p/> + * <p> * updateJob() : update job status and attributes * pauseChildren() : submit or queue commands to pause children * notifyParent() : update the status to upstream if any - * - * @param <T> */ public abstract class PauseTransitionXCommand extends TransitionXCommand<Void> { /** http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java index 5d8d193..94bafa5 100644 --- a/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/RerunTransitionXCommand.java @@ -24,7 +24,7 @@ import org.apache.oozie.util.StatusUtils; /** * Transition command for rerun the job. The derived class has to override these following functions: - * <p/> + * <p> * updateJob() : update job status and attributes * rerunChildren() : submit or queue commands to rerun children * notifyParent() : update the status to upstream if any http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/StartTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/StartTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/StartTransitionXCommand.java index 9ca9cfa..9f85e1f 100644 --- a/core/src/main/java/org/apache/oozie/command/StartTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/StartTransitionXCommand.java @@ -22,7 +22,7 @@ import org.apache.oozie.client.Job; /** * Transition command for start the job. The derived class has to override these following functions: - * <p/> + * <p> * loadState() : load the job's and/or actions' state * updateJob() : update job status and attributes * StartChildren() : submit or queue commands to start children http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/SubmitTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/SubmitTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/SubmitTransitionXCommand.java index 070cee5..9a4e586 100644 --- a/core/src/main/java/org/apache/oozie/command/SubmitTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/SubmitTransitionXCommand.java @@ -22,7 +22,7 @@ import org.apache.oozie.client.Job; /** * Base class for submit transition command. The derived class has to override these following functions: - * <p/> + * <p> * loadState() : load the job's and/or actions' state * submit() : submit the job * notifyParent() : update the status to upstream if any http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java index fc4bf80..6024138 100644 --- a/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/TransitionXCommand.java @@ -74,9 +74,8 @@ public abstract class TransitionXCommand<T> extends XCommand<T> { /** * This will be used to generate Job Notification events on status changes * - * @param user - * @param appName - * @param em + * @param coordJob + * @param startTime * @throws CommandException */ public void generateEvents(CoordinatorJobBean coordJob, Date startTime) throws CommandException { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/UnpauseTransitionXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/UnpauseTransitionXCommand.java b/core/src/main/java/org/apache/oozie/command/UnpauseTransitionXCommand.java index cd9ecc2..1dfd3b5 100644 --- a/core/src/main/java/org/apache/oozie/command/UnpauseTransitionXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/UnpauseTransitionXCommand.java @@ -23,12 +23,10 @@ import org.apache.oozie.client.Job; /** * Transition command for unpause the job. The derived class has to override these following functions: - * <p/> + * <p> * updateJob() : update job status and attributes * unpauseChildren() : submit or queue commands to unpause children * notifyParent() : update the status to upstream if any - * - * @param <T> */ public abstract class UnpauseTransitionXCommand extends TransitionXCommand<Void> { /** http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/XCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/XCommand.java b/core/src/main/java/org/apache/oozie/command/XCommand.java index 655670d..ff87510 100644 --- a/core/src/main/java/org/apache/oozie/command/XCommand.java +++ b/core/src/main/java/org/apache/oozie/command/XCommand.java @@ -42,9 +42,9 @@ import java.util.concurrent.atomic.AtomicBoolean; /** * Base class for synchronous and asynchronous commands. - * <p/> + * <p> * It enables by API the following pattern: - * <p/> + * <p> * <ul> * <li>single execution: a command instance can be executed only once</li> * <li>eager data loading: loads data for eager precondition check</li> @@ -54,7 +54,7 @@ import java.util.concurrent.atomic.AtomicBoolean; * <li>locking: obtains exclusive lock on key before executing the command</li> * <li>execution: command logic</li> * </ul> - * <p/> + * <p> * It has built in instrumentation and logging. */ public abstract class XCommand<T> implements XCallable<T> { @@ -129,7 +129,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Return the callable type. - * <p/> + * <p> * The command type is used for concurrency throttling in the {@link CallableQueueService}. * * @return the command type. @@ -161,9 +161,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Queue a command for execution after the current command execution completes. - * <p/> + * <p> * All commands queued during the execution of the current command will be queued for a single serial execution. - * <p/> + * <p> * If the command execution throws an exception, no command will be effectively queued. * * @param command command to queue. @@ -174,10 +174,10 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Queue a command for delayed execution after the current command execution completes. - * <p/> + * <p> * All commands queued during the execution of the current command with the same delay will be queued for a single * serial execution. - * <p/> + * <p> * If the command execution throws an exception, no command will be effectively queued. * * @param command command to queue. @@ -197,7 +197,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Obtain an exclusive lock on the {link #getEntityKey}. - * <p/> + * <p> * A timeout of {link #getLockTimeOut} is used when trying to obtain the lock. * * @throws InterruptedException thrown if an interruption happened while trying to obtain the lock @@ -237,7 +237,7 @@ public abstract class XCommand<T> implements XCallable<T> { * Implements the XCommand life-cycle. * * @return the {link #execute} return value. - * @throws Exception thrown if the command could not be executed. + * @throws CommandException thrown if the command could not be executed. */ @Override public final T call() throws CommandException { @@ -391,9 +391,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Return the time out when acquiring a lock. - * <p/> + * <p> * The value is loaded from the Oozie configuration, the property {link #DEFAULT_LOCK_TIMEOUT}. - * <p/> + * <p> * Subclasses should override this method if they want to use a different time out. * * @return the lock time out in milliseconds. @@ -404,7 +404,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Indicate if the the command requires locking. - * <p/> + * <p> * Subclasses should override this method if they require locking. * * @return <code>true/false</code> @@ -413,7 +413,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Return the entity key for the command. - * <p/> + * <p> * * @return the entity key for the command. */ @@ -421,9 +421,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Indicate if the the command requires to requeue itself if the lock is not acquired. - * <p/> + * <p> * Subclasses should override this method if they don't want to requeue. - * <p/> + * <p> * Default is true. * * @return <code>true/false</code> @@ -434,11 +434,11 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Load the necessary state to perform an eager precondition check. - * <p/> + * <p> * This implementation does a NOP. - * <p/> + * <p> * Subclasses should override this method and load the state needed to do an eager precondition check. - * <p/> + * <p> * A trivial implementation is calling {link #loadState}. */ protected void eagerLoadState() throws CommandException{ @@ -446,9 +446,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Verify the precondition for the command before obtaining a lock. - * <p/> + * <p> * This implementation does a NOP. - * <p/> + * <p> * A trivial implementation is calling {link #verifyPrecondition}. * * @throws CommandException thrown if the precondition is not met. @@ -458,7 +458,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Load the necessary state to perform the precondition check and to execute the command. - * <p/> + * <p> * Subclasses must implement this method and load the state needed to do the precondition check and execute the * command. */ @@ -466,7 +466,7 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Verify the precondition for the command after a lock has been obtain, just before executing the command. - * <p/> + * <p> * * @throws CommandException thrown if the precondition is not met. */ @@ -474,9 +474,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Command execution body. - * <p/> + * <p> * This method will be invoked after the {link #loadState} and {link #verifyPrecondition} methods. - * <p/> + * <p> * If the command requires locking, this method will be invoked ONLY if the lock has been acquired. * * @return a return value from the execution of the command, only meaningful if the command is executed @@ -496,7 +496,7 @@ public abstract class XCommand<T> implements XCallable<T> { } /** - * @param used set false to the used + * Set false to the used */ public void resetUsed() { this.used.set(false); @@ -505,9 +505,9 @@ public abstract class XCommand<T> implements XCallable<T> { /** * Return the delay time for requeue - * <p/> + * <p> * The value is loaded from the Oozie configuration, the property {link #DEFAULT_REQUEUE_DELAY}. - * <p/> + * <p> * Subclasses should override this method if they want to use a different requeue delay time * * @return delay time when requeue itself http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/bundle/BundleJobsXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/bundle/BundleJobsXCommand.java b/core/src/main/java/org/apache/oozie/command/bundle/BundleJobsXCommand.java index b39d5cc..09dbdf6 100644 --- a/core/src/main/java/org/apache/oozie/command/bundle/BundleJobsXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/bundle/BundleJobsXCommand.java @@ -44,7 +44,7 @@ public class BundleJobsXCommand extends XCommand<BundleJobInfo> { * * @param filter the filter string * @param start start location for paging - * @param len total length to get + * @param length total length to get */ public BundleJobsXCommand(Map<String, List<String>> filter, int start, int length) { super("bundle.job.info", "bundle.job.info", 1); http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/bundle/BundleRerunXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/bundle/BundleRerunXCommand.java b/core/src/main/java/org/apache/oozie/command/bundle/BundleRerunXCommand.java index 90d72e3..4cd175b 100644 --- a/core/src/main/java/org/apache/oozie/command/bundle/BundleRerunXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/bundle/BundleRerunXCommand.java @@ -49,9 +49,9 @@ import org.apache.oozie.util.XLog; /** * Rerun bundle coordinator jobs by a list of coordinator names or dates. User can specify if refresh or noCleanup. - * <p/> + * <p> * The "refresh" is used to indicate if user wants to refresh an action's input/outpur dataset urls - * <p/> + * <p> * The "noCleanup" is used to indicate if user wants to cleanup output events for given rerun actions */ public class BundleRerunXCommand extends RerunTransitionXCommand<Void> { http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/bundle/BundleSubmitXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/bundle/BundleSubmitXCommand.java b/core/src/main/java/org/apache/oozie/command/bundle/BundleSubmitXCommand.java index de78ab7..5d4e0f0 100644 --- a/core/src/main/java/org/apache/oozie/command/bundle/BundleSubmitXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/bundle/BundleSubmitXCommand.java @@ -296,8 +296,6 @@ public class BundleSubmitXCommand extends SubmitTransitionXCommand { * Read bundle definition. * * @param appPath application path. - * @param user user name. - * @param group group name. * @return bundle definition. * @throws BundleJobException thrown if the definition could not be read. */ http://git-wip-us.apache.org/repos/asf/oozie/blob/fcbab934/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java b/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java index 0ec5a89..d4c98c8 100644 --- a/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java +++ b/core/src/main/java/org/apache/oozie/command/coord/CoordActionsKillXCommand.java @@ -49,10 +49,10 @@ import org.apache.oozie.util.ParamChecker; /** * Kill coordinator actions by a range of dates (nominal time) or action number. - * <p/> - * The "range" can be set with {@link RestConstants.JOB_COORD_SCOPE_DATE} or - * {@link RestConstants.JOB_COORD_SCOPE_ACTION}. - * <p/> + * <p> + * The "range" can be set with {@link RestConstants#JOB_COORD_SCOPE_DATE} or + * {@link RestConstants#JOB_COORD_SCOPE_ACTION}. + * <p> */ public class CoordActionsKillXCommand extends KillTransitionXCommand<CoordinatorActionInfo> {
