Skip to content

Commit

Permalink
Merge pull request #150 from jglick/StepExecutions-links
Browse files Browse the repository at this point in the history
Link to `StepExecutions` in relevant Javadoc
  • Loading branch information
jglick committed Jan 18, 2024
2 parents 03be811 + 87f9eb5 commit 899e07e
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ public void onStart(StepContext context) {}
* You lose some power this way ({@link #onStart} and per-body {@link StepContext})
* but may be convenient if you already have a {@link FutureCallback} from some other source.
* For example, you can wrap your own {@link StepContext} if your step is a tail call to its body.
* @see StepExecutions#block
*/
public static BodyExecutionCallback wrap(FutureCallback<Object> v) {
return v instanceof BodyExecutionCallback ? (BodyExecutionCallback)v : new Wrapper(v);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ public abstract class Step extends AbstractDescribableImpl<Step> implements Exte
* @throws Exception
* if any exception is thrown, {@link Step} is assumed to have completed abnormally synchronously
* (as if {@link StepContext#onFailure} is called and the method returned true.)
* @see StepExecutions
*/
public abstract StepExecution start(StepContext context) throws Exception;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* @author Kohsuke Kawaguchi
* @author Jesse Glick
* @see Step#start(StepContext)
* @see StepExecutions#block
*/
public abstract class StepExecution implements Serializable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

/**
* Similar to {@link SynchronousStepExecution} (it executes synchronously too) but it does not block the CPS VM thread.
* @see StepExecution
* @param <T> the type of the return value (may be {@link Void})
* @see StepExecutions#synchronousNonBlocking
*/
public abstract class SynchronousNonBlockingStepExecution<T> extends StepExecution {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*
* @param <T> the type of the return value (may be {@link Void})
* @author Kohsuke Kawaguchi
* @see StepExecutions#synchronous
*/
public abstract class SynchronousStepExecution<T> extends StepExecution {
private transient volatile Thread executing;
Expand Down

0 comments on commit 899e07e

Please sign in to comment.