Added missing docs for batch.core and batch.core.configuration packages #4068
Conversation
| @@ -74,10 +74,21 @@ | |||
|
|
|||
| private final String exitDescription; | |||
|
|
|||
| /** | |||
| * Constructor that accepts the exitCode and sets the exitDescription to an empty {@link String}. | |||
There was a problem hiding this comment.
Change exitCode and exitDescription to exit code and exit description (that is, say it in English rather than Java).
| public ExitStatus(String exitCode) { | ||
| this(exitCode, ""); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor that establishes the exitCode and the exitDescription for the {@link ExitStatus}. |
There was a problem hiding this comment.
Change exitCode and exitDescription to exit code and exit description (that is, say it in English rather than Java).
| @@ -98,45 +102,78 @@ public JobExecution(JobInstance job, Long id, @Nullable JobParameters jobParamet | |||
| /** | |||
| * Constructor for transient (unsaved) instances. | |||
| * | |||
| * @param job the enclosing {@link JobInstance} | |||
| * @param jobParameters {@link JobParameters} instance for this JobExecution. | |||
| * @param job The enclosing {@link JobInstance} | |||
| @@ -297,6 +334,10 @@ public void setLastUpdated(Date lastUpdated) { | |||
| this.lastUpdated = lastUpdated; | |||
| } | |||
|
|
|||
| /** | |||
| * Retrieve a list of exceptions. | |||
| * @return The {@link List} of {@link Throwable}s. | |||
| public JobParameters() { | ||
| this.parameters = new LinkedHashMap<>(); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor that is initialized with content of a {@link Map} that contains a string key and {@link JobParameter} value. |
There was a problem hiding this comment.
Change "with content" to "with the content".
| public static final String STRING_TYPE = "(string)"; | ||
|
|
||
| /** | ||
| * Parameter key suffix representing the long type. | ||
| */ | ||
| public static final String LONG_TYPE = "(long)"; | ||
|
|
||
| private static final String DOUBLE_TYPE = "(double)"; |
There was a problem hiding this comment.
Add a similar description for this one.
| @@ -45,7 +45,7 @@ | |||
| * <p> | |||
| * Implementation of {@link JobRepository} that stores JobInstances, | |||
There was a problem hiding this comment.
Change JobInstances to job instances. (English rather than Java. Also, unless there is an object named JobInstances, it's an error to use the term.
| @@ -45,7 +45,7 @@ | |||
| * <p> | |||
| * Implementation of {@link JobRepository} that stores JobInstances, | |||
| * JobExecutions, and StepExecutions using the injected DAOs. | |||
There was a problem hiding this comment.
Change "JobExections" and "StepExecutions" to job executions and step executions (respectively). Same comment as the previous line about not referring to objects that don't exist.
These two aren't your fault, I know. However, since we're here....
| */ | ||
| public JobExecution(JobInstance job, JobParameters jobParameters) { | ||
| this(job, null, jobParameters); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor that accepts the current job execution ID and {@link JobParameters}. |
| public JobExecution(Long id, JobParameters jobParameters) { | ||
| this(null, id, jobParameters); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor that accepts the current job execution ID. |
cppwfs
force-pushed
the
BATCH-ADD-JAVADOC-CORE-CONFIG
branch
from
517fe11
to
da9c74e
Compare
| @@ -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}. | |||
There was a problem hiding this comment.
We need "exists" before the first comma. My bad, I think.
No description provided.