Update javadocs (#2485)

Author: akshaysonvane

marklogic-data-hub/src/main/java/com/marklogic/hub/FlowManager.java

@@ -73,6 +73,7 @@ public interface FlowManager {
      * Creates a flow
      *
      * @param flowName - name of the flow
+     * @return a Flow object
      */
     Flow createFlow(String flowName);
 
@@ -109,30 +110,30 @@ public interface FlowManager {
 
     /**
      * Check if a flow has existed
-     * @param flowName
-     * @return
+     * @param flowName a flow name
+     * @return a boolean value
      */
     boolean isFlowExisted(String flowName);
 
     /**
      *
-     * @param flow
-     * @return
+     * @param flow a flow object
+     * @return a map of steps
      */
     Map<String, Step> getSteps(Flow flow);
 
     /**
      *
-     * @param flow
-     * @param stepMap
+     * @param flow a flow object
+     * @param stepMap a map of steps
      */
     void setSteps(Flow flow, Map<String, Step> stepMap);
 
     /**
      *
-     * @param flow
-     * @param stepNum
-     * @return
+     * @param flow a flow object
+     * @param stepNum step key
+     * @return a step
      */
     Step getStep(Flow flow, String stepNum);
 }

marklogic-data-hub/src/main/java/com/marklogic/hub/deploy/commands/DeployHubDatabaseCommand.java

@@ -46,9 +46,9 @@ public class DeployHubDatabaseCommand extends DeployDatabaseCommand {
      * user config directory. That will then cause the ordering of database commands to be incorrect, which will
      * likely cause an error when databases are deployed and they don't yet exist.
      *
-     * @param hubConfig
-     * @param databaseFile
-     * @param databaseFilename
+     * @param hubConfig a hubConfig object
+     * @param databaseFile database file object
+     * @param databaseFilename name of the database file
      */
     public DeployHubDatabaseCommand(HubConfig hubConfig, File databaseFile, String databaseFilename) {
         super(databaseFilename);

marklogic-data-hub/src/main/java/com/marklogic/hub/flow/Flow.java

@@ -38,42 +38,42 @@ public interface Flow {
     /**
      * Returns flow description
      *
-     * @return
+     * @return - a flow description
      */
     String getDescription();
 
     /**
      * Sets flow description
      *
-     * @param description
+     * @param description a flow description
      */
     void setDescription(String description);
 
     /**
      * Returns flow batch size
      *
-     * @return
+     * @return - flow batch size
      */
     int getBatchSize();
 
     /**
      * Set flow batch size
      *
-     * @param batchSize
+     * @param batchSize flow batch size
      */
     void setBatchSize(int batchSize);
 
     /**
      * Returns flow thread count
      *
-     * @return
+     * @return thread count for flow
      */
     int getThreadCount();
 
     /**
      * Sets flow thread count
      *
-     * @param threadCount
+     * @param threadCount thread count for flow
      */
     void setThreadCount(int threadCount);
 
@@ -137,13 +137,14 @@ public interface Flow {
     void setOverrideStepConfig(Map<String, Object> overrideStepConfig);
 
     /**
-     *
-     * @param stopOnError
+     * If set stops the flow on error
+     * @param stopOnError boolean flag to stop on error
      */
     void setStopOnError(boolean stopOnError);
+
     /**
-     *
-     * @return
+     * Returns the value for stop on error flag
+     * @return boolean flag to stop on error
      */
     boolean isStopOnError();
 
@@ -155,7 +156,7 @@ public interface Flow {
 
     /**
      * Sets version
-     * @param version
+     * @param version version for the flow
      */
     void setVersion(int version);
 
@@ -170,8 +171,8 @@ public interface Flow {
     /**
      * Get step Info by step id
      *
-     * @param stepId
-     * @return
+     * @param stepId id for the step
+     * @return a step
      */
     Step getStepById(String stepId);
 }

marklogic-data-hub/src/main/java/com/marklogic/hub/flow/FlowRunner.java

@@ -14,7 +14,7 @@ public interface FlowRunner {
      *
      * @param flow the flow to run
      * @param jobId the jobid to be used for the flow
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, String jobId);
 
@@ -24,7 +24,7 @@ public interface FlowRunner {
      * @param flow the flow to run
      * @param steps the steps in the flow to run
      * @param jobId the jobid to be used for the flow
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, List<String> steps, String jobId);
 
@@ -34,7 +34,7 @@ public interface FlowRunner {
      * @param flow the flow to run
      * @param jobId the jobid to be used for the flow
      * @param options the key/value options to be passed
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, String jobId, Map<String, Object> options);
 
@@ -45,7 +45,7 @@ public interface FlowRunner {
      * @param steps the steps in the flow to run
      * @param jobId the jobid to be used for the flow
      * @param options the key/value options to be passed
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, List<String> steps, String jobId, Map<String, Object> options);
 
@@ -57,7 +57,7 @@ public interface FlowRunner {
      * @param jobId the jobid to be used for the flow
      * @param options the key/value options to be passed
      * @param stepConfig the key/value config to override the running of the step
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, List<String> steps, String jobId, Map<String, Object> options, Map<String, Object> stepConfig);
 
@@ -66,15 +66,15 @@ public interface FlowRunner {
      *
      * @param flow the flow to run
      * @param steps the steps in the flow to run
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow, List<String> steps);
 
     /**
      * Runs the entire flow, with full defaults
      *
      * @param flow the flow to run
-     *
+     * @return a response object
      */
     RunFlowResponse runFlow(String flow);
 
@@ -98,6 +98,7 @@ public interface FlowRunner {
      * @param unit the time unit of the timeout argument
      *
      * @throws InterruptedException if interrupted while waiting
+     * @throws TimeoutException if times out
      */
     void awaitCompletion(long timeout, TimeUnit unit) throws InterruptedException, TimeoutException;
 

marklogic-data-hub/src/main/java/com/marklogic/hub/impl/DataHubImpl.java

@@ -127,9 +127,9 @@ public void wireClient() {
     /**
      * Need to account for the group name in case the user has overridden the name of the "Default" group.
      *
-     * @param manageClient
-     * @param hubConfig
-     * @return
+     * @param manageClient manageClient object
+     * @param hubConfig hubConfig object
+     * @return constructed ServerManager object
      */
     protected ServerManager constructServerManager(ManageClient manageClient, HubConfig hubConfig) {
         AppConfig appConfig = hubConfig.getAppConfig();
@@ -563,7 +563,7 @@ public void updateIndexes() {
     /**
      * In a provisioned environment, only the databases defined by this pattern can be updated.
      *
-     * @return
+     * @return database name pattern
      */
     protected Pattern buildPatternForDatabasesToUpdateIndexesFor() {
         return Pattern.compile("(staging|final|job)-database.json");

marklogic-data-hub/src/main/java/com/marklogic/hub/impl/HubConfigImpl.java

@@ -1837,7 +1837,7 @@ private void updateAppConfig(AppConfig config) {
      * But if the config paths have been customized - most likely via mlConfigPaths in gradle.properties - then this
      * method just ensures that they're relative to the DHF project directory.
      *
-     * @param config
+     * @param config an AppConfig object
      */
     protected void initializeConfigDirs(AppConfig config) {
         final String defaultConfigPath = String.join(File.separator, "src", "main", "ml-config");
@@ -1868,7 +1868,7 @@ protected void initializeConfigDirs(AppConfig config) {
     /**
      * Need to initialize every module path as being relative to the current project directory.
      *
-     * @param config
+     * @param config an AppConfig object
      */
     protected void initializeModulePaths(AppConfig config) {
         List<String> modulePaths = new ArrayList<>();
@@ -1970,8 +1970,8 @@ public void refreshProject(Properties properties, boolean loadGradleProperties)
      * properties plugin does. But it is being preserved for backwards compatibility in case any clients prior to
      * 4.1 were using HubConfigBuilder.withPropertiesFromEnvironment.
      *
-     * @param environment
-     * @return
+     * @param environment a string name for environment
+     * @return a hubconfig object
      */
     @JsonIgnore
     public HubConfig withPropertiesFromEnvironment(String environment) {

marklogic-data-hub/src/main/java/com/marklogic/hub/job/JobMonitor.java

@@ -23,6 +23,7 @@ public interface JobMonitor {
 
     /**
      * Sets the flow to be used with the flow runner
+     * @param jobId the id of the job
      * @param batchId the id of the batch
      * @return string denoting status of the batch
      *

marklogic-data-hub/src/main/java/com/marklogic/hub/legacy/LegacyFlowManager.java

@@ -33,7 +33,7 @@ public interface LegacyFlowManager {
 
     /**
      * Set HubConfig
-     * @param hubConfig
+     * @param hubConfig a hubConfig object
      */
     void setHubConfig(HubConfig hubConfig);
 

marklogic-data-hub/src/main/java/com/marklogic/hub/step/StepDefinition.java

@@ -259,18 +259,18 @@ static StepDefinition create(String name, StepDefinitionType type) {
 
     /**
      *
-     * @param stepName
-     * @param stepDefinition
-     * @param step
-     * @return
+     * @param stepName name of the step
+     * @param stepDefinition step definition object to transform from
+     * @param step step object to be transformed
+     * @return a transformed step object
      */
     Step transformToStep(String stepName, StepDefinition stepDefinition, Step step);
 
     /**
      *
-     * @param stepDefinition
-     * @param step
-     * @return
+     * @param stepDefinition step definition to be transformed
+     * @param step step object to transform from
+     * @return a transformed step definition object
      */
     StepDefinition transformFromStep(StepDefinition stepDefinition, Step step);
 }

marklogic-data-hub/src/main/java/com/marklogic/hub/step/StepRunner.java

@@ -142,6 +142,7 @@ public interface StepRunner {
      * @param unit the time unit of the timeout argument
      *
      * @throws InterruptedException if interrupted while waiting
+     * @throws TimeoutException if times out
      */
     void awaitCompletion(long timeout, TimeUnit unit) throws InterruptedException, TimeoutException;
 
@@ -168,7 +169,7 @@ public interface StepRunner {
 
     /**
      * Returns the batch size
-     *
+     * @return batch size for step runner
      */
      int getBatchSize();