Skip to content

Commit 78e5827

Browse files
manick02cb-manick
authored andcommitted
Update Readme with usage of util dependency
Changed field to final in WorkflowUtils Signed-off-by: cb-manick <[email protected]>
1 parent ebcd89b commit 78e5827

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ With the SDK you can:
1111
* Programmatically build workflow definitions
1212
* Validate workflow definitions (both schema and workflow integrity validation)
1313
* Generate workflow diagram (SVG)
14+
* Set of utilities to help runtimes interpret the Serverless Workflow object model
1415

1516
Serverless Workflow Java SDK is **not** a workflow runtime implementation but can be used by Java runtime implementations
1617
to parse and validate workflow definitions as well as generate the workflow diagram (SVG).
@@ -82,6 +83,12 @@ b) Add the following dependencies to your pom.xml `dependencies` section:
8283
<artifactId>serverlessworkflow-diagram</artifactId>
8384
<version>4.0.0-SNAPSHOT</version>
8485
</dependency>
86+
87+
<dependency>
88+
<groupId>io.serverlessworkflow</groupId>
89+
<artifactId>serverlessworkflow-util</artifactId>
90+
<version>4.0.0-SNAPSHOT</version>
91+
</dependency>
8592
```
8693

8794
#### Gradle projects:
@@ -99,6 +106,7 @@ implementation("io.serverlessworkflow:serverlessworkflow-api:4.0.0-SNAPSHOT")
99106
implementation("io.serverlessworkflow:serverlessworkflow-spi:4.0.0-SNAPSHOT")
100107
implementation("io.serverlessworkflow:serverlessworkflow-validation:4.0.0-SNAPSHOT")
101108
implementation("io.serverlessworkflow:serverlessworkflow-diagram:4.0.0-SNAPSHOT")
109+
implementation("io.serverlessworkflow:serverlessworkflow-util:4.0.0-SNAPSHOT")
102110
```
103111

104112
### How to Use

utils/src/main/java/io/serverlessworkflow/utils/WorkflowUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
/** Provides common utility methods to provide most often needed answers from a workflow */
2323
public final class WorkflowUtils {
24-
private static int DEFAULT_STARTING_STATE_POSITION = 0;
24+
private static final int DEFAULT_STARTING_STATE_POSITION = 0;
2525
/**
2626
* Gets State matching Start state.If start is not present returns first state otherwise returns
2727
* null

0 commit comments

Comments
 (0)