Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish

Browse Source
This commit is contained in:
Michael Minella
2017-09-14 14:29:26 -05:00
parent 6bdbe3029e
commit 340406a61f
40 changed files with 92 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-batch-core/src/main/java/org/springframework/batch/core/JobExecution.java
View File

@@ -16,8 +16,6 @@
package org.springframework.batch.core;
import org.springframework.batch.item.ExecutionContext;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.ArrayList;
@@ -30,6 +28,8 @@ import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CopyOnWriteArraySet;
import org.springframework.batch.item.ExecutionContext;
/**
* Batch domain object representing the execution of a job.
*
@@ -89,7 +89,7 @@ public class JobExecution extends Entity {
* @param id {@link Long} that represents the id for the JobExecution.
* @param jobParameters {@link JobParameters} instance for this JobExecution.
* @param jobConfigurationName {@link String} instance that represents the
* job configuration name.
* job configuration name (used with JSR-352).
*/
public JobExecution(JobInstance job, Long id, JobParameters jobParameters, String jobConfigurationName) {
super(id);
@@ -218,7 +218,8 @@ public class JobExecution extends Entity {
/**
* Register a step execution with the current job execution.
* @param stepName the name of the step the new execution is associated with
* @return {@link StepExecution} instance created by this method.
* @return {@link StepExecution} an empty {@code StepExecution} associated with this
* {@code JobExecution}.
*/
public StepExecution createStepExecution(String stepName) {
StepExecution stepExecution = new StepExecution(stepName, this);

9
spring-batch-core/src/main/java/org/springframework/batch/core/StepContribution.java
View File

@@ -44,7 +44,8 @@ public class StepContribution implements Serializable {
private ExitStatus exitStatus = ExitStatus.EXECUTING;
/**
* @param execution {@link StepExecution} instance to be used by the step contribution.
* @param execution {@link StepExecution} the stepExecution used to initialize
* {@code skipCount}.
*/
public StepContribution(StepExecution execution) {
this.parentSkipCount = execution.getSkipCount();
@@ -71,7 +72,7 @@ public class StepContribution implements Serializable {
/**
* Increment the counter for the number of items processed.
*
* @param count int used to set the increment filter count.
* @param count int amount to increment by.
*/
public void incrementFilterCount(int count) {
filterCount += count;
@@ -87,7 +88,7 @@ public class StepContribution implements Serializable {
/**
* Increment the counter for the number of items written.
*
* @param count int used to increment the write count.
* @param count int amount to increment by.
*/
public void incrementWriteCount(int count) {
writeCount += count;
@@ -147,7 +148,7 @@ public class StepContribution implements Serializable {
/**
* Increment the read skip count for this contribution
*
* @param count int used to increment the read skip count.
* @param count int amount to increment by.
*/
public void incrementReadSkipCount(int count) {
readSkipCount += count;

2
spring-batch-core/src/main/java/org/springframework/batch/core/StepExecution.java
View File

@@ -236,7 +236,7 @@ public class StepExecution extends Entity {
/**
* Setter for number of rollbacks for this execution
* @param rollbackCount int used to set the rollbackCount.
* @param rollbackCount int the number of rollbacks.
*/
public void setRollbackCount(int rollbackCount) {
this.rollbackCount = rollbackCount;

4
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/DuplicateJobException.java
View File

@@ -31,14 +31,14 @@ public class DuplicateJobException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg error message.
*/
public DuplicateJobException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg error message.
* @param e instance of {@link Throwable} that is the cause of the exception.
*/
public DuplicateJobException(String msg, Throwable e) {

48
spring-batch-core/src/main/java/org/springframework/batch/core/configuration/xml/StepParserStepFactoryBean.java
View File

@@ -16,6 +16,23 @@
package org.springframework.batch.core.configuration.xml;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Queue;
import java.util.Set;
import java.util.concurrent.locks.ReentrantLock;
import javax.batch.api.chunk.listener.RetryProcessListener;
import javax.batch.api.chunk.listener.RetryReadListener;
import javax.batch.api.chunk.listener.RetryWriteListener;
import javax.batch.api.chunk.listener.SkipProcessListener;
import javax.batch.api.chunk.listener.SkipReadListener;
import javax.batch.api.chunk.listener.SkipWriteListener;
import javax.batch.api.partition.PartitionCollector;
import org.springframework.batch.core.ChunkListener;
import org.springframework.batch.core.ItemProcessListener;
import org.springframework.batch.core.ItemReadListener;
@@ -79,23 +96,6 @@ import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.interceptor.DefaultTransactionAttribute;
import org.springframework.util.Assert;
import javax.batch.api.chunk.listener.RetryProcessListener;
import javax.batch.api.chunk.listener.RetryReadListener;
import javax.batch.api.chunk.listener.RetryWriteListener;
import javax.batch.api.chunk.listener.SkipProcessListener;
import javax.batch.api.chunk.listener.SkipReadListener;
import javax.batch.api.chunk.listener.SkipWriteListener;
import javax.batch.api.partition.PartitionCollector;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Queue;
import java.util.Set;
import java.util.concurrent.locks.ReentrantLock;
/**
* This {@link FactoryBean} is used by the batch namespace parser to create {@link Step} objects. Stores all of the
* properties that are configurable on the <step/> (and its inner <tasklet/>). Based on which properties are
@@ -757,7 +757,7 @@ public class StepParserStepFactoryBean<I, O> implements FactoryBean<Step>, BeanN
/**
* Public setter for {@link JobRepository}.
*
* @param jobRepository {@link JobRepository} instance to be used by the factory bean.
* @param jobRepository {@link JobRepository} instance to be used by the step.
*/
public void setJobRepository(JobRepository jobRepository) {
this.jobRepository = jobRepository;
@@ -775,7 +775,7 @@ public class StepParserStepFactoryBean<I, O> implements FactoryBean<Step>, BeanN
/**
* A preconfigured {@link Tasklet} to use.
*
* @param tasklet {@link Tasklet} instance to be used by the factory bean.
* @param tasklet {@link Tasklet} instance to be used by step.
*/
public void setTasklet(Tasklet tasklet) {
this.tasklet = tasklet;
@@ -787,7 +787,7 @@ public class StepParserStepFactoryBean<I, O> implements FactoryBean<Step>, BeanN
/**
* @return transactionManager instance of {@link PlatformTransactionManager}
* used by the factory bean.
* used by the step.
*/
public PlatformTransactionManager getTransactionManager() {
return transactionManager;
@@ -1137,28 +1137,28 @@ public class StepParserStepFactoryBean<I, O> implements FactoryBean<Step>, BeanN
// =========================================================
/**
* @param hasChunkElement true if step has &lt;chunk&gt; element.
* @param hasChunkElement true if step has &lt;chunk/&gt; element.
*/
public void setHasChunkElement(boolean hasChunkElement) {
this.hasChunkElement = hasChunkElement;
}
/**
* @return true if the defined step has a &lt;chunk&gt; element
* @return true if the defined step has a &lt;chunk/&gt; element
*/
protected boolean hasChunkElement() {
return this.hasChunkElement;
}
/**
* @return true if the defined step has a &lt;tasklet&gt; element
* @return true if the defined step has a &lt;tasklet/&gt; element
*/
protected boolean hasTasklet() {
return this.tasklet != null;
}
/**
* @return true if the defined step has a &lt;partition&gt; element
* @return true if the defined step has a &lt;partition/&gt; element
*/
protected boolean hasPartitionElement() {
return this.partitionHandler != null;

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecution.java
View File

@@ -26,7 +26,7 @@ public class FlowExecution implements Comparable<FlowExecution> {
private final FlowExecutionStatus status;
/**
* @param name the flow execution name to be associated with the FlowExecution.
* @param name the flow name to be associated with the FlowExecution.
* @param status the {@link FlowExecutionStatus} to be associated with the FlowExecution.
*/
public FlowExecution(String name, FlowExecutionStatus status) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutionException.java
View File

@@ -23,14 +23,14 @@ package org.springframework.batch.core.job.flow;
public class FlowExecutionException extends Exception {
/**
* @param message the message to be associated with this exception.
* @param message the error message.
*/
public FlowExecutionException(String message) {
super(message);
}
/**
* @param message the message to be associated with this exception.
* @param message the error message.
* @param cause instance of {@link Throwable} that caused this exception.
*/
public FlowExecutionException(String message, Throwable cause) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutionStatus.java
View File

@@ -64,7 +64,7 @@ public class FlowExecutionStatus implements Comparable<FlowExecutionStatus> {
}
/**
* @param status String containing the status to be associated with this instance.
* @param status String status value.
*/
public FlowExecutionStatus(String status) {
this.name = status;

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/FlowExecutor.java
View File

@@ -67,7 +67,7 @@ public interface FlowExecutor {
* Handle any status changes that might be needed in the
* {@link JobExecution}.
*
* @param status instance of {@link FlowExecutionStatus} to be associated with FlowExecutor.
* @param status status to update the {@link JobExecution} to.
*/
void updateJobExecutionStatus(FlowExecutionStatus status);

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/JobFlowExecutor.java
View File

@@ -136,7 +136,7 @@ public class JobFlowExecutor implements FlowExecutor {
}
/**
* @param status instance of {@link FlowExecutionStatus}.
* @param status {@link FlowExecutionStatus} to convert.
* @return A {@link BatchStatus} appropriate for the {@link FlowExecutionStatus} provided
*/
protected BatchStatus findBatchStatus(FlowExecutionStatus status) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/AbstractState.java
View File

@@ -29,7 +29,7 @@ public abstract class AbstractState implements State {
private final String name;
/**
* @param name to be used by the state.
* @param name of the state.
*/
public AbstractState(String name) {
this.name = name;

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/DecisionState.java
View File

@@ -32,7 +32,7 @@ public class DecisionState extends AbstractState {
/**
* @param decider the {@link JobExecutionDecider} instance to make the status decision.
* @param name the name to be associated with the decision state.
* @param name the name of the decision state.
*/
public DecisionState(JobExecutionDecider decider, String name) {
super(name);

4
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/FlowState.java
View File

@@ -35,8 +35,8 @@ public class FlowState extends AbstractState implements FlowHolder {
private final Flow flow;
/**
* @param flow the {@link Flow} instance to be used by the state.
* @param name the name to be associated with the state.
* @param flow the {@link Flow} to delegate to.
* @param name the name of the state.
*/
public FlowState(Flow flow, String name) {
super(name);

2
spring-batch-core/src/main/java/org/springframework/batch/core/job/flow/support/state/SplitState.java
View File

@@ -50,7 +50,7 @@ public class SplitState extends AbstractState implements FlowHolder {
/**
* @param flows collection of {@link Flow} instances.
* @param name the name to be associated with the state.
* @param name the name of the state.
*/
public SplitState(Collection<Flow> flows, String name) {
super(name);

4
spring-batch-core/src/main/java/org/springframework/batch/core/jsr/launch/JsrJobOperator.java
View File

@@ -177,7 +177,7 @@ public class JsrJobOperator implements JobOperator, ApplicationContextAware, Ini
* @param jobExplorer an instance of Spring Batch's {@link JobExplorer}.
* @param jobRepository an instance of Spring Batch's {@link JobOperator}.
* @param jobParametersConverter an instance of Spring Batch's {@link JobParametersConverter}.
* @param transactionManager and instance of Spring Batch's {@link javax.transaction.TransactionManager}.
* @param transactionManager a {@link javax.transaction.TransactionManager}.
*/
public JsrJobOperator(JobExplorer jobExplorer, JobRepository jobRepository, JobParametersConverter jobParametersConverter, PlatformTransactionManager transactionManager) {
Assert.notNull(jobExplorer, "A JobExplorer is required");
@@ -719,7 +719,7 @@ public class JsrJobOperator implements JobOperator, ApplicationContextAware, Ini
*
* @param executionId the database id for the {@link JobExecution} to be stopped.
* @throws NoSuchJobExecutionException thrown if {@link JobExecution} instance does not exist.
* @throws JobExecutionNotRunningException thrownif {@link JobExecution} is not running.
* @throws JobExecutionNotRunningException thrown if {@link JobExecution} is not running.
*/
@Override
public void stop(long executionId) throws NoSuchJobExecutionException,

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobExecutionNotFailedException.java
View File

@@ -30,14 +30,14 @@ public class JobExecutionNotFailedException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to the caller.
* @param msg the error message.
*/
public JobExecutionNotFailedException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller
* @param msg the error message
* @param e the cause of the exception
*/
public JobExecutionNotFailedException(String msg, Throwable e) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobInstanceAlreadyExistsException.java
View File

@@ -32,14 +32,14 @@ public class JobInstanceAlreadyExistsException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg the error message.
*/
public JobInstanceAlreadyExistsException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg the error message.
* @param e the cause of the exception.
*/
public JobInstanceAlreadyExistsException(String msg, Throwable e) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobLauncher.java
View File

@@ -48,7 +48,7 @@ public interface JobLauncher {
* JobExecution will be returned, and the status will need to be inspected.
*
* @param job the job to be executed.
* @param jobParameters the parameters to be associated with the job.
* @param jobParameters the parameters passed to this execution of the job.
* @return the {@link JobExecution} if it returns synchronously. If the
* implementation is asynchronous, the status might well be unknown.
*

15
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobOperator.java
View File

@@ -15,6 +15,10 @@
*/
package org.springframework.batch.core.launch;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.springframework.batch.core.Job;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobInstance;
@@ -27,10 +31,6 @@ import org.springframework.batch.core.repository.JobExecutionAlreadyRunningExcep
import org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException;
import org.springframework.batch.core.repository.JobRestartException;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Low level interface for inspecting and controlling jobs with access only to
* primitive and collection types. Suitable for a command-line client (e.g. that
@@ -50,7 +50,8 @@ public interface JobOperator {
* @param instanceId the id of a {@link JobInstance}
* @return the id values of all the {@link JobExecution JobExecutions}
* associated with this instance
* @throws NoSuchJobInstanceException is thrown if job for instance id does not exist.
* @throws NoSuchJobInstanceException if the {@link JobInstance} associated with the
* {@code instanceId} cannot be found.
*/
List<Long> getExecutions(long instanceId) throws NoSuchJobInstanceException;
@@ -62,7 +63,7 @@ public interface JobOperator {
* @param start the start index of the instances
* @param count the maximum number of values to return
* @return the id values of the {@link JobInstance JobInstances}
* @throws NoSuchJobException is thrown if job for the jobName does not exist.
* @throws NoSuchJobException is thrown if no {@link JobInstance}s for the jobName exist.
*/
List<Long> getJobInstances(String jobName, int start, int count) throws NoSuchJobException;
@@ -99,7 +100,7 @@ public interface JobOperator {
* name
* @throws JobInstanceAlreadyExistsException if a job instance with this
* name and parameters already exists
* @throws JobParametersInvalidException thrown if some of the job parameters are invalid.
* @throws JobParametersInvalidException thrown if any of the job parameters are invalid.
*/
Long start(String jobName, String parameters) throws NoSuchJobException, JobInstanceAlreadyExistsException, JobParametersInvalidException;

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/JobParametersNotFoundException.java
View File

@@ -32,14 +32,14 @@ public class JobParametersNotFoundException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg the error message.
*/
public JobParametersNotFoundException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg the error message.
* @param e the cause of the exception.
*/
public JobParametersNotFoundException(String msg, Throwable e) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/NoSuchJobException.java
View File

@@ -32,14 +32,14 @@ public class NoSuchJobException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg the error message.
*/
public NoSuchJobException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg the error message.
* @param e the cause of the exception.
*/
public NoSuchJobException(String msg, Throwable e) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/NoSuchJobExecutionException.java
View File

@@ -31,14 +31,14 @@ public class NoSuchJobExecutionException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg the error message.
*/
public NoSuchJobExecutionException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg the error message.
* @param e the cause of the exception.
*/
public NoSuchJobExecutionException(String msg, Throwable e) {

4
spring-batch-core/src/main/java/org/springframework/batch/core/launch/NoSuchJobInstanceException.java
View File

@@ -31,14 +31,14 @@ public class NoSuchJobInstanceException extends JobExecutionException {
/**
* Create an exception with the given message.
*
* @param msg The message to send to caller.
* @param msg the error message.
*/
public NoSuchJobInstanceException(String msg) {
super(msg);
}
/**
* @param msg The message to send to caller.
* @param msg the error message.
* @param e the cause of the exception.
*/
public NoSuchJobInstanceException(String msg, Throwable e) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemProcessListener.java
View File

@@ -41,7 +41,7 @@ public class CompositeItemProcessListener<T, S> implements ItemProcessListener<T
/**
* Register additional listener.
*
* @param itemProcessorListener instance of {@link ItemProcessListener} to be called when process events occur.
* @param itemProcessorListener instance of {@link ItemProcessListener} to be registered.
*/
public void register(ItemProcessListener<? super T, ? super S> itemProcessorListener) {
listeners.add(itemProcessorListener);

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemReadListener.java
View File

@@ -42,7 +42,7 @@ public class CompositeItemReadListener<T> implements ItemReadListener<T> {
/**
* Register additional listener.
*
* @param itemReaderListener instance of {@link ItemReadListener} to be called when read events occur.
* @param itemReaderListener instance of {@link ItemReadListener} to be registered.
*/
public void register(ItemReadListener<? super T> itemReaderListener) {
listeners.add(itemReaderListener);

3
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeItemWriteListener.java
View File

@@ -18,7 +18,6 @@ package org.springframework.batch.core.listener;
import java.util.Iterator;
import java.util.List;
import org.springframework.batch.core.ItemProcessListener;
import org.springframework.batch.core.ItemWriteListener;
import org.springframework.core.Ordered;
@@ -43,7 +42,7 @@ public class CompositeItemWriteListener<S> implements ItemWriteListener<S> {
/**
* Register additional listener.
*
* @param itemWriteListener list of {@link ItemWriteListener}s to be called when write events occur.
* @param itemWriteListener list of {@link ItemWriteListener}s to be registered.
*/
public void register(ItemWriteListener<? super S> itemWriteListener) {
listeners.add(itemWriteListener);

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeJobExecutionListener.java
View File

@@ -42,7 +42,7 @@ public class CompositeJobExecutionListener implements JobExecutionListener {
/**
* Register additional listener.
*
* @param jobExecutionListener instance {@link JobExecutionListener} to be called when job execution events occur.
* @param jobExecutionListener instance {@link JobExecutionListener} to be registered.
*/
public void register(JobExecutionListener jobExecutionListener) {
listeners.add(jobExecutionListener);

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeSkipListener.java
View File

@@ -41,7 +41,7 @@ public class CompositeSkipListener<T,S> implements SkipListener<T,S> {
/**
* Register additional listener.
*
* @param listener instance of {@link SkipListener} to be called when skip events occur.
* @param listener instance of {@link SkipListener} to be registered.
*/
public void register(SkipListener<? super T,? super S> listener) {
listeners.add(listener);

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/CompositeStepExecutionListener.java
View File

@@ -44,7 +44,7 @@ public class CompositeStepExecutionListener implements StepExecutionListener {
/**
* Register additional listener.
*
* @param stepExecutionListener instance of {@link StepExecutionListener} to be called when step execution events occur.
* @param stepExecutionListener instance of {@link StepExecutionListener} to be registered.
*/
public void register(StepExecutionListener stepExecutionListener) {
list.add(stepExecutionListener);

2
spring-batch-core/src/main/java/org/springframework/batch/core/listener/ExecutionContextPromotionListener.java
View File

@@ -99,7 +99,7 @@ public class ExecutionContextPromotionListener extends StepExecutionListenerSupp
* If set to TRUE, the listener will throw an exception if any 'key' is not
* found in the Step {@link ExecutionContext}. FALSE by default.
*
* @param strict boolean value to establish the state of the strict flag.
* @param strict boolean the value of the flag.
*/
public void setStrict(boolean strict) {
this.strict = strict;

4
spring-batch-core/src/main/java/org/springframework/batch/core/listener/StepListenerMetaData.java
View File

@@ -91,7 +91,7 @@ public enum StepListenerMetaData implements ListenerMetaData {
}
static{
propertyMap = new HashMap<String, StepListenerMetaData>();
propertyMap = new HashMap<>();
for(StepListenerMetaData metaData : values()){
propertyMap.put(metaData.getPropertyName(), metaData);
}
@@ -125,7 +125,7 @@ public enum StepListenerMetaData implements ListenerMetaData {
/**
* Return the relevant meta data for the provided property name.
*
* @param propertyName name of the {@link StepListenerMetaData} to retrieve.
* @param propertyName property name to retrieve data for.
* @return meta data with supplied property name, null if none exists.
*/
public static StepListenerMetaData fromPropertyName(String propertyName){

2
spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/DefaultExecutionContextSerializer.java
View File

@@ -46,7 +46,7 @@ public class DefaultExecutionContextSerializer implements ExecutionContextSerial
* Serializes an execution context to the provided {@link OutputStream}. The
* stream is not closed prior to it's return.
*
* @param context {@link Map} containing the context information.
* @param context {@link Map} contents of the {@code ExecutionContext}.
* @param out {@link OutputStream} where the serialized context information
* will be written.
*/

2
spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JdbcExecutionContextDao.java
View File

@@ -98,7 +98,7 @@ public class JdbcExecutionContextDao extends AbstractJdbcBatchMetadataDao implem
* Default value is 2500. Clients using multi-bytes charsets on the database
* server may need to reduce this value to as little as half the value of
* the column size.
* @param shortContextLength int containing the shortContextLength.
* @param shortContextLength int max length of the short context.
*/
public void setShortContextLength(int shortContextLength) {
this.shortContextLength = shortContextLength;

2
spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JobExecutionDao.java
View File

@@ -54,7 +54,7 @@ public interface JobExecutionDao {
* Return all {@link JobExecution}s for given {@link JobInstance}, sorted
* backwards by creation order (so the first element is the most recent).
*
* @param jobInstance {@link JobInstance} instance to find.
* @param jobInstance parent {@link JobInstance} of the {@link JobExecution}s to find.
* @return {@link List} containing JobExecutions for the jobInstance.
*/
List<JobExecution> findJobExecutions(JobInstance jobInstance);

2
spring-batch-core/src/main/java/org/springframework/batch/core/step/AbstractStep.java
View File

@@ -83,7 +83,7 @@ public abstract class AbstractStep implements Step, InitializingBean, BeanNameAw
/**
* Set the name property. Always overrides the default value if this object is a Spring bean.
* @param name the name to use for the {@link Step}.
* @param name the name of the {@link Step}.
* @see #setBeanName(java.lang.String)
*/
public void setName(String name) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/step/builder/FaultTolerantStepBuilder.java
View File

@@ -359,7 +359,7 @@ public class FaultTolerantStepBuilder<I, O> extends SimpleStepBuilder<I, O> {
/**
* Explicitly request certain exceptions (and subclasses) to be skipped.
*
* @param type the class type.
* @param type the exception type.
* @return this for fluent chaining
*/
public FaultTolerantStepBuilder<I, O> skip(Class<? extends Throwable> type) {

2
spring-batch-core/src/main/java/org/springframework/batch/core/step/factory/FaultTolerantStepFactoryBean.java
View File

@@ -209,7 +209,7 @@ public class FaultTolerantStepFactoryBean<T, S> extends SimpleStepFactoryBean<T,
}
/**
* @param processorTransactional boolean to set the state of the processorTransactional for the factory bean.
* @param processorTransactional boolean indicates if the {@code ItemProcessor} participates in the transaction.
*/
public void setProcessorTransactional(boolean processorTransactional) {
this.processorTransactional = processorTransactional;

6
spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SimpleChunkProcessor.java
View File

@@ -161,7 +161,7 @@ public class SimpleChunkProcessor<I, O> implements ChunkProcessor<I>, Initializi
/**
* Call the listener's after write method.
*
* @param items list of items that will be passed to {@link MulticasterBatchListener#afterWrite(List)}.
* @param items list of items that were just written.
*/
protected final void doAfterWrite(List<O> items) {
listener.afterWrite(items);
@@ -169,8 +169,8 @@ public class SimpleChunkProcessor<I, O> implements ChunkProcessor<I>, Initializi
/**
* Call listener's writerError method.
* @param e exception that occured.
* @param items list of items that will be passed to {@link MulticasterBatchListener#onWriteError(Exception, List)}.
* @param e exception that occurred.
* @param items list of items that failed to be written.
*/
protected final void doOnWriteError(Exception e, List<O> items) {
listener.onWriteError(e, items);

4
spring-batch-core/src/main/java/org/springframework/batch/core/step/item/SkipWrapper.java
View File

@@ -29,14 +29,14 @@ public class SkipWrapper<T> {
final private T item;
/**
* @param item the item that is associated with the SkipWrapper.
* @param item the item being wrapped.
*/
public SkipWrapper(T item) {
this(item, null);
}
/**
* @param e instance of {@link Throwable} that is associated with the SkipWrapper.
* @param e instance of {@link Throwable} that being wrapped.
*/
public SkipWrapper(Throwable e) {
this(null, e);

2
spring-batch-core/src/main/java/org/springframework/batch/core/step/tasklet/SystemCommandTasklet.java
View File

@@ -235,7 +235,7 @@ public class SystemCommandTasklet extends StepExecutionListenerSupport implement
* executing the system command if {@link #setTimeout(long)} has been
* exceeded or user interrupts the job. <code>false</code> by default
*
* @param interruptOnCancel boolean to establish state of interruptOnCancel
* @param interruptOnCancel boolean determines if process should be interrupted
*/
public void setInterruptOnCancel(boolean interruptOnCancel) {
this.interruptOnCancel = interruptOnCancel;