Improving defaults

Author: scottf

.github/workflows/build-main.yml

@@ -17,7 +17,7 @@ jobs:
       SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
     steps:
       - name: Setup JDK
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: '21'
           distribution: 'temurin'

.github/workflows/build-release.yml

@@ -18,7 +18,7 @@ jobs:
       SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
     steps:
       - name: Setup JDK
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           java-version: '21'
           distribution: 'temurin'

build.gradle

@@ -15,13 +15,20 @@ def jarVersion = "3.0.2"
 group = 'io.nats'
 
 def isRelease = System.getenv("BUILD_EVENT") == "release"
+def tc = System.getenv("TARGET_COMPATIBILITY");
+def targetCompat = tc == "21" ? JavaVersion.VERSION_21 : (tc == "17" ? JavaVersion.VERSION_17 : JavaVersion.VERSION_1_8)
+def jarEnd =       tc == "21" ?  "-jdk21"              : (tc == "17" ? "-jdk17"               : "")
+def jarAndArtifactName = "jnats-server-runner" + jarEnd
 
-// version is the variable the build actually uses.
-version = isRelease ? jarVersion : jarVersion + "-SNAPSHOT"
+version = isRelease ? jarVersion : jarVersion + "-SNAPSHOT" // version is the variable the build actually uses.
+
+System.out.println("Java: " + System.getProperty("java.version"))
+System.out.println("Target Compatibility: " + targetCompat)
+System.out.println(group + ":" + jarAndArtifactName + ":" + version)
 
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = targetCompat
 }
 
 repositories {
@@ -31,6 +38,8 @@ repositories {
 }
 
 dependencies {
+    implementation 'org.jspecify:jspecify:1.0.0'
+
     testImplementation 'org.junit.jupiter:junit-jupiter:5.14.1'
     testImplementation 'nl.jqno.equalsverifier:equalsverifier:4.2.1'
 
@@ -46,7 +55,8 @@ jar {
         bnd("Bundle-Name": "io.nats.jnats.server.runner",
                 "Bundle-Vendor": "nats.io",
                 "Bundle-Description": "NATS.IO Java Server Runner",
-                "Bundle-DocURL": "https://github.com/nats-io/java-nats-server-runner"
+                "Bundle-DocURL": "https://github.com/nats-io/java-nats-server-runner",
+                "Target-Compatibility": "Java " + targetCompat
         )
     }
 }
@@ -67,6 +77,7 @@ test {
 }
 
 javadoc {
+    failOnError = false
     options.overview = 'src/main/javadoc/overview.html' // relative to source root
     source = sourceSets.main.allJava
     title = "NATS.IO Java Server Runner"
@@ -116,11 +127,11 @@ publishing {
             artifact sourcesJar
             artifact javadocJar
             pom {
-                name = "jnats-server-runner"
+                name = jarAndArtifactName
                 packaging = "jar"
                 groupId = group
-                artifactId = "jnats-server-runner"
-                description = "Java NATS.io server runner."
+                artifactId = jarAndArtifactName
+                description = "Java NATS.io Server Runner"
                 url = 'https://github.com/nats-io/java-nats-server-runner'
                 licenses {
                     license {

src/main/java/io/nats/ClusterInsert.java

@@ -13,17 +13,38 @@
 
 package io.nats;
 
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Object that represents the lines needed to add to the conf for a custer instance
+ */
 public class ClusterInsert {
+    /**
+     * The node
+     */
     public final ClusterNode node;
+
+    /**
+     * The actual inserts
+     */
     public final String[] configInserts;
 
-    public ClusterInsert(ClusterNode node, String[] configInserts) {
+    /**
+     * Construct a ClusterInsert
+     * @param node the node
+     * @param configInserts the inserts
+     */
+    public ClusterInsert(@NonNull ClusterNode node, String @Nullable [] configInserts) {
         this.node = node;
         this.configInserts = configInserts == null || configInserts.length == 0 ? null : configInserts;
     }
 
     @Override
     public String toString() {
+        if (configInserts == null) {
+            return node.toString();
+        }
         StringBuilder sb = new StringBuilder();
         for (String s : configInserts) {
             sb.append(s).append("\r\n");

src/main/java/io/nats/ClusterNode.java

@@ -13,30 +13,59 @@
 
 package io.nats;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.NullUnmarked;
+import org.jspecify.annotations.Nullable;
+
 import java.nio.file.Path;
 
+/**
+ * An object representing a single server node
+ */
+@NullMarked
 public class ClusterNode {
+    /** The name of the cluster */
     public final String clusterName;
+    /** The name of the server */
     public final String serverName;
+    /** The port */
     public final int port;
+    /** The listen port */
     public final int listen;
-    public final String host;
-    public final Integer monitor;
-    public final Path jsStoreDir;
-
+    /** The host */
+    @Nullable public final String host;
+    /** The monitor port, may be null */
+    @Nullable public final Integer monitor;
+    /** A custom path to use as the JetStream storage directory */
+    @Nullable public final Path jsStoreDir;
+
+    /**
+     * Construct a ClusterNode
+     * @param clusterName the cluster name
+     * @param serverName the server name
+     * @param port the port
+     * @param listen the listen port
+     */
     public ClusterNode(String clusterName, String serverName, int port, int listen) {
         this(clusterName, serverName, null, port, listen, null, null);
     }
 
-    public ClusterNode(String clusterName, String serverName, int port, int listen, Integer monitor) {
+    /**
+     * Construct a ClusterNode
+     * @param clusterName the cluster name
+     * @param serverName the server name
+     * @param port the port
+     * @param listen the listen port
+     */
+    public ClusterNode(String clusterName, String serverName, int port, int listen, @Nullable Integer monitor) {
         this(clusterName, serverName, null, port, listen, monitor, null);
     }
 
-    public ClusterNode(String clusterName, String serverName, int port, int listen, Path jsStoreDir) {
+    public ClusterNode(String clusterName, String serverName, int port, int listen, @Nullable Path jsStoreDir) {
         this(clusterName, serverName, null, port, listen, null, jsStoreDir);
     }
 
-    public ClusterNode(String clusterName, String serverName, String host, int port, int listen, Integer monitor, Path jsStoreDir) {
+    public ClusterNode(String clusterName, String serverName, @Nullable String host, int port, int listen, @Nullable Integer monitor, @Nullable Path jsStoreDir) {
         this.clusterName = clusterName;
         this.serverName = serverName;
         this.host = host;
@@ -46,15 +75,29 @@ public ClusterNode(String clusterName, String serverName, String host, int port,
         this.jsStoreDir = jsStoreDir;
     }
 
+    @Override
+    public String toString() {
+        return "ClusterNode{" +
+            "clusterName='" + clusterName + '\'' +
+            ", serverName='" + serverName + '\'' +
+            ", port=" + port +
+            ", listen=" + listen +
+            ", host='" + host + '\'' +
+            ", monitor=" + monitor +
+            ", jsStoreDir=" + jsStoreDir +
+            '}';
+    }
+
     public static Builder builder() {
         return new Builder();
     }
 
+    @NullUnmarked
     public static class Builder {
         private String clusterName;
         private String serverName;
-        private int port;
-        private int listen;
+        private int port = -1;
+        private int listen = -1;
         private String host;
         private Integer monitor;
         private Path jsStoreDir;