From bc46d345c6cd7c52beff70d880860246f2a9eb4a Mon Sep 17 00:00:00 2001 From: Jens Pots Date: Thu, 23 May 2024 17:49:27 +0200 Subject: [PATCH] docs: listed available data types --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f21b7c..83a2c8e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,30 @@ A proof-of-concept implementation of a Kotlin-based JVM runner. -#### Notes +### Features + +#### Datatypes + +At the time of writing, the JVM Runner supports a limit set of datatypes and classes. You may use either wrapper classes or the primitive types directly. + +| URI | Java Mapping | +|---------------------------|--------------------| +| `jvm:HttpChannelReader` | `bridge.Reader` | +| `jvm:HttpChannelWriter` | `bridge.Writer` | +| `jvm:MemoryChannelReader` | `bridge.Reader` | +| `jvm:MemoryChannelWriter` | `bridge.Writer` | +| `xsd:boolean` | `boolean` | +| `xsd:byte` | `byte` | +| `xsd:dateTime` | `java.util.Date` | +| `xsd:double` | `double` | +| `xsd:float` | `float` | +| `xsd:int` | `int` | +| `xsd:long` | `long` | +| `xsd:string` | `java.lang.String` | + +Note that SHACL will validate your processor, so out-of-range or invalid values will be caught. + +### Contributor Guide ###### Pre-Commit Hooks