Add more javadoc.

Signed-off-by: Hiram Chirino <hiram@hiramchirino.com>

Author: chirino

proxy-wasm-java-host/src/main/java/io/roastedroot/proxywasm/SimpleMetricsHandler.java

@@ -16,6 +16,13 @@
  */
 public class SimpleMetricsHandler implements MetricsHandler {
 
+    /**
+     * Default constructor.
+     */
+    public SimpleMetricsHandler() {
+        // Default constructor for SimpleMetricsHandler
+    }
+
     /**
      * Represents an individual metric managed by {@link SimpleMetricsHandler}.
      * Stores the metric's ID, type, name, and its current value.
@@ -42,27 +49,35 @@ public Metric(int id, MetricType type, String name) {
         }
 
         /**
+         * Gets the unique integer ID of the metric.
+         *
          * @return The unique integer ID of the metric.
          */
         public int id() {
             return id;
         }
 
         /**
+         * Gets the type of the metric.
+         *
          * @return The {@link MetricType} of the metric.
          */
         public MetricType type() {
             return type;
         }
 
         /**
+         * Gets the name of the metric.
+         *
          * @return The name of the metric.
          */
         public String name() {
             return name;
         }
 
         /**
+         * Gets the current value of the metric.
+         *
          * @return The current value of the metric.
          */
         public long getValue() {

proxy-wasm-java-host/src/main/java/io/roastedroot/proxywasm/SimpleSharedDataHandler.java

@@ -15,6 +15,13 @@
  */
 public class SimpleSharedDataHandler implements SharedDataHandler {
 
+    /**
+     * Default constructor.
+     */
+    public SimpleSharedDataHandler() {
+        // Default constructor for SimpleSharedDataHandler
+    }
+
     private final HashMap<String, SharedData> sharedData = new HashMap<>();
 
     /**

proxy-wasm-java-host/src/main/java/io/roastedroot/proxywasm/SimpleSharedQueueHandler.java

@@ -16,6 +16,13 @@
  */
 public class SimpleSharedQueueHandler implements SharedQueueHandler {
 
+    /**
+     * Default constructor.
+     */
+    public SimpleSharedQueueHandler() {
+        // Default constructor for SimpleSharedQueueHandler
+    }
+
     /**
      * Represents an individual shared queue managed by {@link SimpleSharedQueueHandler}.
      * Each queue has a unique name (within its VM), a host-assigned ID, and holds its data

quarkus-proxy-wasm-example/src/main/java/io/roastedroot/proxywasm/jaxrs/example/App.java

@@ -5,21 +5,37 @@
 import com.dylibso.chicory.wasm.WasmModule;
 import io.roastedroot.proxywasm.Plugin;
 import io.roastedroot.proxywasm.PluginFactory;
-import io.roastedroot.proxywasm.StartException;
 import jakarta.enterprise.context.ApplicationScoped;
 import jakarta.enterprise.inject.Produces;
 import java.nio.file.Path;
 
+/**
+ * Application configuration class for the proxy-wasm JAX-RS example.
+ * Sets up the Wasm PluginFactory for the example plugin.
+ */
 @ApplicationScoped
 public class App {
 
+    /**
+     * Default constructor.
+     */
+    public App() {
+        // Default constructor
+    }
+
     private static WasmModule module =
             Parser.parse(
                     Path.of("../proxy-wasm-java-host/src/test/go-examples/unit_tester/main.wasm"));
 
-    // configure the the example wasm plugin
+    /**
+     * Produces the PluginFactory for the example Wasm plugin.
+     * Configures the plugin with necessary settings like name, shared status,
+     * plugin configuration, and machine factory.
+     *
+     * @return A configured PluginFactory for the example plugin.
+     */
     @Produces
-    public PluginFactory example() throws StartException {
+    public PluginFactory example() {
         return () ->
                 Plugin.builder(module)
                         .withName("example")

quarkus-proxy-wasm-example/src/main/java/io/roastedroot/proxywasm/jaxrs/example/Resources.java

@@ -4,9 +4,26 @@
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 
+/**
+ * JAX-RS resource class for the proxy-wasm example.
+ * Defines endpoints for testing the Wasm plugin.
+ */
 @Path("/")
 public class Resources {
 
+    /**
+     * Default constructor.
+     */
+    public Resources() {
+        // Default constructor
+    }
+
+    /**
+     * Handles GET requests to the /test path.
+     * Applies the "example" Wasm plugin.
+     *
+     * @return A simple "Hello World" string.
+     */
     @Path("/test")
     @GET
     @WasmPlugin("example") // filter with example wasm plugin

quarkus-proxy-wasm/integration-tests/src/main/java/io/quarkiverse/proxywasm/it/App.java

@@ -13,16 +13,43 @@
 import java.nio.file.Path;
 import java.util.Map;
 
+/**
+ * Application configuration for integration tests.
+ * Provides CDI producers for various {@link PluginFactory} configurations used in tests.
+ */
 @ApplicationScoped
 public class App {
 
+    /**
+     * Default constructor.
+     */
+    public App() {
+        // Default constructor
+    }
+
+    /**
+     * Directory containing the example Wasm modules used for testing.
+     */
     public static final String EXAMPLES_DIR = "../../proxy-wasm-java-host/src/test";
+
     private static final Gson gson = new Gson();
 
+    /**
+     * Parses a Wasm module from the specified file path relative to the examples directory.
+     *
+     * @param file The relative path to the Wasm module file.
+     * @return The parsed {@link WasmModule}.
+     */
     public static WasmModule parseTestModule(String file) {
         return Parser.parse(Path.of(EXAMPLES_DIR + file));
     }
 
+    /**
+     * Produces a {@link PluginFactory} for header manipulation tests (shared instance).
+     *
+     * @return A configured {@link PluginFactory}.
+     * @throws StartException If plugin initialization fails.
+     */
     @Produces
     public PluginFactory headerTests() throws StartException {
         return () ->
@@ -34,6 +61,12 @@ public PluginFactory headerTests() throws StartException {
                         .build();
     }
 
+    /**
+     * Produces a {@link PluginFactory} for header manipulation tests (non-shared instances).
+     *
+     * @return A configured {@link PluginFactory}.
+     * @throws StartException If plugin initialization fails.
+     */
     @Produces
     public PluginFactory headerTestsNotShared() throws StartException {
         return () ->
@@ -45,6 +78,12 @@ public PluginFactory headerTestsNotShared() throws StartException {
                         .build();
     }
 
+    /**
+     * Produces a {@link PluginFactory} for tick-based tests.
+     *
+     * @return A configured {@link PluginFactory}.
+     * @throws StartException If plugin initialization fails.
+     */
     @Produces
     public PluginFactory tickTests() throws StartException {
         return () ->
@@ -57,6 +96,12 @@ public PluginFactory tickTests() throws StartException {
                         .build();
     }
 
+    /**
+     * Produces a {@link PluginFactory} for Foreign Function Interface (FFI) tests.
+     *
+     * @return A configured {@link PluginFactory}.
+     * @throws StartException If plugin initialization fails.
+     */
     @Produces
     public PluginFactory ffiTests() throws StartException {
         return () ->
@@ -70,6 +115,12 @@ public PluginFactory ffiTests() throws StartException {
                         .build();
     }
 
+    /**
+     * Reverses the byte order of the input data. Used as an FFI function in tests.
+     *
+     * @param data The byte array to reverse.
+     * @return A new byte array with the reversed content.
+     */
     public static byte[] reverse(byte[] data) {
         byte[] reversed = new byte[data.length];
         for (int i = 0; i < data.length; i++) {
@@ -78,6 +129,12 @@ public static byte[] reverse(byte[] data) {
         return reversed;
     }
 
+    /**
+     * Produces a {@link PluginFactory} for HTTP call tests.
+     *
+     * @return A configured {@link PluginFactory}.
+     * @throws StartException If plugin initialization fails.
+     */
     @Produces
     public PluginFactory httpCallTests() throws StartException {
         return () ->

quarkus-proxy-wasm/integration-tests/src/main/java/io/quarkiverse/proxywasm/it/MockLogger.java

@@ -4,13 +4,22 @@
 import io.roastedroot.proxywasm.LogLevel;
 import java.util.ArrayList;
 
+/**
+ * A mock implementation of {@link LogHandler} for testing purposes.
+ * Stores logged messages in memory and optionally prints them to the console if DEBUG is enabled.
+ */
 public class MockLogger implements LogHandler {
 
     static final boolean DEBUG = "true".equals(System.getenv("DEBUG"));
 
     final ArrayList<String> loggedMessages = new ArrayList<>();
     private final String name;
 
+    /**
+     * Constructs a new MockLogger with the given name.
+     *
+     * @param name The name to associate with logged messages.
+     */
     public MockLogger(String name) {
         this.name = name;
     }
@@ -28,6 +37,11 @@ public synchronized LogLevel getLogLevel() {
         return LogLevel.TRACE;
     }
 
+    /**
+     * Retrieves a copy of all messages logged by this instance.
+     *
+     * @return A new {@link ArrayList} containing the logged messages.
+     */
     public synchronized ArrayList<String> loggedMessages() {
         return new ArrayList<>(loggedMessages);
     }