Remove JavaDoc warnings part 2

This commit is contained in:
Glenn Renfro
2017-08-31 09:26:26 -04:00
committed by Michael Minella
parent cf97912ec9
commit 6bdbe3029e
116 changed files with 436 additions and 249 deletions

View File

@@ -126,6 +126,8 @@ public abstract class AbstractJobTests implements ApplicationContextAware {
* Launch the entire job, including all steps.
*
* @return JobExecution, so that the test can validate the exit status
*
* @throws Exception is thrown if error occurs.
*/
protected JobExecution launchJob() throws Exception {
return this.launchJob(this.getUniqueJobParameters());
@@ -136,6 +138,8 @@ public abstract class AbstractJobTests implements ApplicationContextAware {
*
* @param jobParameters parameters for the job
* @return JobExecution, so that the test can validate the exit status
*
* @throws Exception is thrown if error occurs.
*/
protected JobExecution launchJob(JobParameters jobParameters) throws Exception {
return getJobLauncher().run(this.job, jobParameters);

View File

@@ -69,7 +69,7 @@ public class DataSourceInitializer implements InitializingBean, DisposableBean {
/**
* Main method as convenient entry point.
*
* @param args
* @param args arguments to be passed to main.
*/
@SuppressWarnings("resource")
public static void main(String... args) {

View File

@@ -66,8 +66,8 @@ import org.springframework.context.ApplicationContext;
*/
public class JobLauncherTestUtils {
private static final long JOB_PARAMETER_MAXIMUM = 1000000;
private static final long JOB_PARAMETER_MAXIMUM = 1000000;
/** Logger */
protected final Log logger = LogFactory.getLog(getClass());
@@ -135,7 +135,7 @@ public class JobLauncherTestUtils {
* Launch the entire job, including all steps.
*
* @return JobExecution, so that the test can validate the exit status
* @throws Exception
* @throws Exception thrown if error occurs launching the job.
*/
public JobExecution launchJob() throws Exception {
return this.launchJob(this.getUniqueJobParameters());
@@ -144,9 +144,9 @@ public class JobLauncherTestUtils {
/**
* Launch the entire job, including all steps
*
* @param jobParameters
* @param jobParameters instance of {@link JobParameters}.
* @return JobExecution, so that the test can validate the exit status
* @throws Exception
* @throws Exception thrown if error occurs launching the job.
*/
public JobExecution launchJob(JobParameters jobParameters) throws Exception {
return getJobLauncher().run(this.job, jobParameters);
@@ -158,7 +158,7 @@ public class JobLauncherTestUtils {
*/
public JobParameters getUniqueJobParameters() {
Map<String, JobParameter> parameters = new HashMap<String, JobParameter>();
parameters.put("random", new JobParameter((long) (Math.random() * JOB_PARAMETER_MAXIMUM)));
parameters.put("random", new JobParameter((long) (Math.random() * JOB_PARAMETER_MAXIMUM)));
return new JobParameters(parameters);
}

View File

@@ -123,6 +123,10 @@ public class JobRepositoryTestUtils extends AbstractJdbcBatchMetadataDao impleme
* @param count the required number of instances of {@link JobExecution} to
* create
* @return a collection of {@link JobExecution}
*
* @throws JobExecutionAlreadyRunningException thrown if Job is already running.
* @throws JobRestartException thrown if Job is not restartable.
* @throws JobInstanceAlreadyCompleteException thrown if Job Instance is already complete.
*/
public List<JobExecution> createJobExecutions(String jobName, String[] stepNames, int count)
throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException {
@@ -146,6 +150,9 @@ public class JobRepositoryTestUtils extends AbstractJdbcBatchMetadataDao impleme
* @param count the required number of instances of {@link JobExecution} to
* create
* @return a collection of {@link JobExecution}
* @throws JobExecutionAlreadyRunningException thrown if Job is already running.
* @throws JobRestartException thrown if Job is not restartable.
* @throws JobInstanceAlreadyCompleteException thrown if Job Instance is already complete.
*/
public List<JobExecution> createJobExecutions(int count) throws JobExecutionAlreadyRunningException,
JobRestartException, JobInstanceAlreadyCompleteException {

View File

@@ -48,9 +48,9 @@ public class JsrTestUtils {
* reach one of those statuses within the given timeout, a {@link java.util.concurrent.TimeoutException} is
* thrown.
*
* @param jobName
* @param properties
* @param timeout
* @param jobName the name of the job.
* @param properties job parameters to be associated with the job.
* @param timeout maximum amount of time to wait in milliseconds.
* @return the {@link JobExecution} for the final state of the job
* @throws java.util.concurrent.TimeoutException if the timeout occurs
*/
@@ -82,9 +82,9 @@ public class JsrTestUtils {
* reach one of those statuses within the given timeout, a {@link java.util.concurrent.TimeoutException} is
* thrown.
*
* @param executionId
* @param properties
* @param timeout
* @param executionId the id of the job execution to restart.
* @param properties job parameters to be associated with the job.
* @param timeout maximum amount of time to wait in milliseconds.
* @return the {@link JobExecution} for the final state of the job
* @throws java.util.concurrent.TimeoutException if the timeout occurs
*/

View File

@@ -166,9 +166,10 @@ public class MetaDataInstanceFactory {
/**
* Create a {@link StepExecution} with the parameters provided.
*
* @param stepName the stepName for the {@link StepExecution}
* @param executionId the id for the {@link StepExecution}
* @return a {@link StepExecution} with the given {@link JobExecution}
* @param jobExecution instance of {@link JobExecution}.
* @param stepName the name for the {@link StepExecution}.
* @param executionId the id for the {@link StepExecution}.
* @return a {@link StepExecution} with the given {@link JobExecution}.
*/
public static StepExecution createStepExecution(JobExecution jobExecution, String stepName, Long executionId) {
StepExecution stepExecution = jobExecution.createStepExecution(stepName);