Skip to content

Added missing docs for batch.core and batch.core.configuration packages #4068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public class ExitStatus implements Serializable, Comparable<ExitStatus> {
private final String exitDescription;

/**
* Constructor that accepts the exitCode and sets the exitDescription to an empty {@link String}.
* Constructor that accepts the exit code and sets the exit description to an empty {@link String}.
*
* @param exitCode The exit code to be used for the {@link ExitStatus}.
*/
Expand All @@ -84,7 +84,7 @@ public ExitStatus(String exitCode) {
}

/**
* Constructor that establishes the exitCode and the exitDescription for the {@link ExitStatus}.
* Constructor that establishes the exit code and the exit description for the {@link ExitStatus}.
*
* @param exitCode The exit code to be used for the {@link ExitStatus}.
* @param exitDescription The exit description to be used for the {@link ExitStatus}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,15 @@ public JobExecution(JobInstance job, Long id, @Nullable JobParameters jobParamet
/**
* Constructor for transient (unsaved) instances.
*
* @param job The enclosing {@link JobInstance}
* @param job The enclosing {@link JobInstance}.
* @param jobParameters The {@link JobParameters} instance for this JobExecution.
*/
public JobExecution(JobInstance job, JobParameters jobParameters) {
this(job, null, jobParameters);
}

/**
* Constructor that accepts the current job execution ID and {@link JobParameters}.
* Constructor that accepts the job execution ID and {@link JobParameters}.
* @param id The job execution ID.
* @param jobParameters The {@link JobParameters} for the {@link JobExecution}.
*/
Expand All @@ -119,7 +119,7 @@ public JobExecution(Long id, JobParameters jobParameters) {
}

/**
* Constructor that accepts the current job execution ID.
* Constructor that accepts the job execution ID.
* @param id The job execution ID.
*/
public JobExecution(Long id) {
Expand Down Expand Up @@ -336,7 +336,7 @@ public void setLastUpdated(Date lastUpdated) {

/**
* Retrieve a list of exceptions.
* @return The {@link List} of {@link Throwable}s.
* @return The {@link List} of {@link Throwable} objects.
*/
public List<Throwable> getFailureExceptions() {
return failureExceptions;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public JobParameters() {
}

/**
* Constructor that is initialized with content of a {@link Map} that contains a string key and {@link JobParameter} value.
* Constructor that is initialized with the content of a {@link Map} that contains a string key and {@link JobParameter} value.
* @param parameters The {@link Map} that contains a string key and {@link JobParameter} value.
*/
public JobParameters(Map<String,JobParameter> parameters) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface Step {

/**
* The key to retrieve the batch.stepType.
* The key to retrieve the batch step type.
*/
String STEP_TYPE_KEY = "batch.stepType";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -474,14 +474,14 @@ public void setLastUpdated(Date lastUpdated) {
}

/**
* @return The {@link List} of {@link Throwable}s.
* @return The {@link List} of {@link Throwable} objects.
*/
public List<Throwable> getFailureExceptions() {
return failureExceptions;
}

/**
* Add {@link Throwable} to failure exceptions.
* Add a {@link Throwable} to failure exceptions.
* @param throwable The {@link Throwable} to add to failure exceptions.
*/
public void addFailureException(Throwable throwable) {
Expand Down Expand Up @@ -541,7 +541,7 @@ public String toString() {
}

/**
* @return The {@link String} containing summary of the step execution.
* @return The {@link String} containing a summary of the step execution.
*/
public String getSummary() {
return super.toString()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
public interface JobFactory {

/**
* Create new instance of {@link Job}.
* Create a new instance of {@link Job}.
* @return The {@link Job}.
*/
Job createJob();

/**
* @return The {@link String} containing the {@link Job} Name.
* @return The {@link String} containing the {@link Job} name.
*/
String getJobName();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ public void afterPropertiesSet() throws Exception {
}

/**
* Returns the {@link BatchConfigurer} if one is present in list. Create {@link BatchConfigurer} if configurers list is empty.
* If more than one configurer is present in the list then an {@link IllegalStateException} is thrown.
* If a {@link BatchConfigurer}, return it. If the configurers list is empty, create {@link BatchConfigurer}.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need "exists" before the first comma. My bad, I think.

* If more than one configurer is present in the list, an {@link IllegalStateException} is thrown.
* @param configurers The {@link Collection} of configurers to review.
* @return The {@link BatchConfigurer} that was in the configurers collection or the one created.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public JobExplorer getJobExplorer() {
}

/**
* Initialize the {@link DefaultBatchConfigurer} with the {@link JobRepository}, {@link JobExplorer} and, {@link JobLauncher}.
* Initialize the {@link DefaultBatchConfigurer} with the {@link JobRepository}, {@link JobExplorer}, and {@link JobLauncher}.
*/
@PostConstruct
public void initialize() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public class JobBuilderFactory {
private JobRepository jobRepository;

/**
* @param jobRepository The {@link JobRepository} to be used by builder factory.
* @param jobRepository The {@link JobRepository} to be used by the builder factory.
*/
public JobBuilderFactory(JobRepository jobRepository) {
this.jobRepository = jobRepository;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public JobExplorer jobExplorer() throws Exception {
}

/**
* Creates {@link AutomaticJobRegistrar} bean.
* Creates a {@link AutomaticJobRegistrar} bean.
* @return New instance of {@link AutomaticJobRegistrar}.
* @throws Exception The {@link Exception} thrown if error occurs.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public class StepBuilderFactory {
private PlatformTransactionManager transactionManager;

/**
* Constructor for {@link StepBuilderFactory}.
* Constructor for the {@link StepBuilderFactory}.
* @param jobRepository The {@link JobRepository} to be used by the builder factory.
* @param transactionManager The {@link PlatformTransactionManager} to be used by the builder factory.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public abstract class AbstractFlowParser extends AbstractSingleBeanDefinitionPar
protected static final String NEXT_ELE = "next";

/**
* Establishes a End element.
* Establishes an End element.
*/
protected static final String END_ELE = "end";

Expand Down Expand Up @@ -123,7 +123,7 @@ public abstract class AbstractFlowParser extends AbstractSingleBeanDefinitionPar
private static final DecisionParser decisionParser = new DecisionParser();

/**
* Used as suffix to generate unique state names for end transitions.
* Used as a suffix to generate unique state names for end transitions.
*/
// For generating unique state names for end transitions
protected static int endCounter = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ else if (listenersElements.size() > 1) {
* Parse the element to retrieve {@link BeanMetadataElement}.
* @param element The {@link Element} to be parsed.
* @param parserContext The {@link ParserContext}.
* @return The {@link BeanMetadataElement} extracted from element parameter.
* @return The {@link BeanMetadataElement} extracted from the element parameter.
*/
public BeanMetadataElement parseBeanElement(Element element, ParserContext parserContext) {
String refAttribute = element.getAttribute(REF_ATTR);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,12 @@

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 org.springframework.batch.core.ChunkListener;
import org.springframework.batch.core.ItemProcessListener;
Expand Down Expand Up @@ -413,7 +410,7 @@ protected void registerItemListeners(SimpleStepBuilder<I, O> builder) {
}

/**
* Creates new {@link TaskletStep}.
* Creates a new {@link TaskletStep}.
* @return The {@link TaskletStep}.
*/
protected Step createSimpleStep() {
Expand Down Expand Up @@ -454,8 +451,8 @@ protected TaskletStep createTaskletStep() {
}

/**
* Set the state of the {@link AbstractTaskletStepBuilder}.
* @param builder The {@link AbstractTaskletStepBuilder} to be enhanced.
* Set the state of the {@link AbstractTaskletStepBuilder} using the values that were established for the factory bean.
* @param builder The {@link AbstractTaskletStepBuilder} to be modified.
*/
@SuppressWarnings("serial")
protected void enhanceTaskletStepBuilder(AbstractTaskletStepBuilder<?> builder) {
Expand Down Expand Up @@ -501,7 +498,7 @@ public boolean rollbackOn(Throwable ex) {
}

/**
* Create new {@link org.springframework.batch.core.job.flow.FlowStep}.
* Create a new {@link org.springframework.batch.core.job.flow.FlowStep}.
* @return The {@link org.springframework.batch.core.job.flow.FlowStep}.
*/
protected Step createFlowStep() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
/**
*
* <p>
* Implementation of {@link JobRepository} that stores JobInstances,
* JobExecutions, and StepExecutions using the injected DAOs.
* Implementation of {@link JobRepository} that stores job instances,
* job executions, and step executions using the injected DAOs.
* </p>
*
* @author Lucas Ward
Expand Down