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
Added missing docs for batch.core and batch.core.configuration packages #4068
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
/* | ||
* Copyright 2006-2021 the original author or authors. | ||
* Copyright 2006-2022 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
|
@@ -74,10 +74,21 @@ 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}. | ||
* | ||
* @param exitCode The exit code to be used for the {@link ExitStatus}. | ||
*/ | ||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Change exitCode and exitDescription to exit code and exit description (that is, say it in English rather than Java). |
||
* | ||
* @param exitCode The exit code to be used for the {@link ExitStatus}. | ||
* @param exitDescription The exit description to be used for the {@link ExitStatus}. | ||
*/ | ||
public ExitStatus(String exitCode, String exitDescription) { | ||
super(); | ||
this.exitCode = exitCode; | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
/* | ||
* Copyright 2006-2021 the original author or authors. | ||
* Copyright 2006-2022 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
|
@@ -65,6 +65,10 @@ public class JobExecution extends Entity { | |
|
||
private transient volatile List<Throwable> failureExceptions = new CopyOnWriteArrayList<>(); | ||
|
||
/** | ||
* Constructor that sets the state of the instance to the {@link JobExecution} parameter. | ||
* @param original The {@link JobExecution} to be copied. | ||
*/ | ||
public JobExecution(JobExecution original) { | ||
this.jobParameters = original.getJobParameters(); | ||
this.jobInstance = original.getJobInstance(); | ||
|
@@ -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} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add a period at the end. |
||
* @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}. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove "current". |
||
* @param id The job execution ID. | ||
* @param jobParameters The {@link JobParameters} for the {@link JobExecution}. | ||
*/ | ||
public JobExecution(Long id, JobParameters jobParameters) { | ||
this(null, id, jobParameters); | ||
} | ||
|
||
/** | ||
* Constructor that accepts the current job execution ID. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove "current". |
||
* @param id The job execution ID. | ||
*/ | ||
public JobExecution(Long id) { | ||
this(null, id, null); | ||
} | ||
|
||
/** | ||
* @return The current {@link JobParameters}. | ||
*/ | ||
public JobParameters getJobParameters() { | ||
return this.jobParameters; | ||
} | ||
|
||
/** | ||
* @return The current end time. | ||
*/ | ||
public Date getEndTime() { | ||
return endTime; | ||
} | ||
|
||
/** | ||
* Set the {@link JobInstance} used by the {@link JobExecution}. | ||
* @param jobInstance The {@link JobInstance} used by the {@link JobExecution}. | ||
*/ | ||
public void setJobInstance(JobInstance jobInstance) { | ||
this.jobInstance = jobInstance; | ||
} | ||
|
||
/** | ||
* Set the end time. | ||
* @param endTime The {@link Date} to be used for the end time. | ||
*/ | ||
public void setEndTime(Date endTime) { | ||
this.endTime = endTime; | ||
} | ||
|
||
/** | ||
* @return The current start time. | ||
*/ | ||
public Date getStartTime() { | ||
return startTime; | ||
} | ||
|
||
/** | ||
* Set the start time. | ||
* @param startTime The {@link Date} to be used for the start time. | ||
*/ | ||
public void setStartTime(Date startTime) { | ||
this.startTime = startTime; | ||
} | ||
|
||
/** | ||
* @return The current {@link BatchStatus}. | ||
*/ | ||
public BatchStatus getStatus() { | ||
return status; | ||
} | ||
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
*/ | ||
public List<Throwable> getFailureExceptions() { | ||
return failureExceptions; | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change exitCode and exitDescription to exit code and exit description (that is, say it in English rather than Java).