Skip to content

Commit

Permalink
Add missing javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
gmokki committed Jan 8, 2015
1 parent f60ffb1 commit cc01798
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,34 @@
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.joda.time.DateTime.now;

import java.math.BigInteger;

import org.joda.time.DateTime;
import org.springframework.core.env.Environment;

import java.math.BigInteger;

/**
* Configuration for the workflow execution.
*/
public class WorkflowSettings {
/**
* Minimum delay on execution retry after an error. Unit is milliseconds.
*/
public final int minErrorTransitionDelay;
/**
* Maximum delay on execution retry after an error. Unit is milliseconds.
*/
public final int maxErrorTransitionDelay;
/**
* Length of forced delay to break execution of a step that is considered to be busy looping. Unit is milliseconds.
*/
public final int shortTransitionDelay;
/**
* Immediate transition delay.
*/
public final int immediateTransitionDelay;
/**
* Maximum retry attempts.
*/
public final int maxRetries;

WorkflowSettings(Builder builder) {
Expand Down Expand Up @@ -63,7 +78,7 @@ public Builder(Environment env) {
}

/**
* Set maximum error transition delay.
* Set the maximum delay on execution retry after an error.
*
* @param maxErrorTransitionDelay
* Delay in milliseconds.
Expand All @@ -75,7 +90,7 @@ public Builder setMaxErrorTransitionDelay(int maxErrorTransitionDelay) {
}

/**
* Set minimum error transition delay.
* Set the minimum delay on execution retry after an error.
*
* @param minErrorTransitionDelay
* Delay in milliseconds.
Expand All @@ -87,7 +102,7 @@ public Builder setMinErrorTransitionDelay(int minErrorTransitionDelay) {
}

/**
* Set short transition delay.
* Set the length of forced delay to break execution of a step that is considered to be busy looping.
*
* @param shortTransitionDelay
* Delay in milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,50 @@

import org.joda.time.DateTime;

/**
* Describes one workflow executor.
*/
public class WorkflowExecutor {
/**
* Unique identifier of executor instance. Each time an executor is started it receives a new identifier.
*/
public final int id;
/**
* The host name of the executor.
*/
public final String host;
/**
* Process id of the executor.
*/
public final int pid;
/**
* The executor group of the executor.
*/
public final String executorGroup;
/**
* Time when the executor was started.
*/
public final DateTime started;
/**
* Time when the executor last updated that it is active.
*/
public final DateTime active;
/**
* Time after which the executor is considered dead.
*/
public final DateTime expires;

/**
* Creates a new workflow executor description.
*
* @param id Unique identifier of executor instance
* @param host The host name of the executor
* @param pid Process id of the executor
* @param executorGroup The executor group of the executor
* @param started Time when the executor was started
* @param active Time when the executor last updated that it is active
* @param expires Time after which the executor is considered dead
*/
public WorkflowExecutor(int id, String host, int pid, String executorGroup, DateTime started, DateTime active, DateTime expires) {
this.id = id;
this.host = host;
Expand Down

0 comments on commit cc01798

Please sign in to comment.