Fixup javadoc

coherence-community · Oct 4, 2024 · 057482a · 057482a
1 parent 0ce964f
commit 057482a
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 77 deletions.
diff --git a/pom.xml b/pom.xml
@@ -74,6 +74,7 @@
     <metrics.enabled>false</metrics.enabled>
     <http.hostname>127.0.0.1</http.hostname>
     <http.port>8080</http.port>
+    <anagement.http>none</anagement.http>
   </properties>
 
   <dependencies>
@@ -377,8 +378,9 @@
             <classpath/>
             <argument>-Xmx512m</argument>
             <argument>-Xms512m</argument>
-            <argument>-Dcoherence.log.level=9</argument>
+            <argument>-Dcoherence.log.level=5</argument>
             <argument>-Dcoherence.management=all</argument>
+            <argument>-Dcoherence.management.http=${management.http}</argument>
             <argument>-Dcoherence.ttl=0</argument>
             <argument>-Djava.net.preferIPv4Stack=true</argument>
             <argument>-Dcoherence.wka=127.0.0.1</argument>
@@ -406,6 +408,21 @@
           </execution>
         </executions>
       </plugin>
+
+      <!-- attach javadoc -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>${maven.javadoc.plugin.version}</version>
+        <executions>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
@@ -460,77 +477,6 @@
       </build>
     </profile>
 
-    <!-- JDk11 specifics -->
-    <profile>
-      <id>javadoc-jdk11</id>
-      <activation>
-        <jdk>11</jdk>
-      </activation>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-compiler-plugin</artifactId>
-            <version>${maven.compiler.plugin.version}</version>
-            <configuration>
-              <release>8</release>
-            </configuration>
-          </plugin>
-
-          <!-- attach javadoc -->
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <version>${maven.javadoc.plugin.version}</version>
-            <executions>
-              <execution>
-                <id>attach-javadocs-jdk11</id>
-                <goals>
-                  <goal>jar</goal>
-                </goals>
-              </execution>
-            </executions>
-            <configuration>
-              <additionalDependencies>
-                <additionalDependency>
-                  <groupId>jakarta.xml.bind</groupId>
-                  <artifactId>jakarta.xml.bind-api</artifactId>
-                  <version>${jakarta.xml.bind.version}</version>
-                </additionalDependency>
-                <additionalDependency>
-                  <groupId>jakarta.xml.bind</groupId>
-                  <artifactId>jaxb-impl</artifactId>
-                  <version>${jakarta.xml.bind.version}</version>
-                </additionalDependency>
-                <additionalDependency>
-                  <groupId>jakarta.xml.bind</groupId>
-                  <artifactId>jaxb-api</artifactId>
-                  <version>${jakarta.xml.bind.version}</version>
-                </additionalDependency>
-                <additionalDependency>
-                  <groupId>jakarta.activation</groupId>
-                  <artifactId>jakarta.activation-api</artifactId>
-                  <version>${jakarta.activation.version}</version>
-                </additionalDependency>
-              </additionalDependencies>
-            </configuration>
-          </plugin>
-        </plugins>
-      </build>
-      <dependencies>
-        <dependency>
-          <groupId>jakarta.xml.bind</groupId>
-          <artifactId>jakarta.xml.bind-api</artifactId>
-          <version>${jakarta.xml.bind.version}</version>
-        </dependency>
-        <dependency>
-          <groupId>jakarta.activation</groupId>
-          <artifactId>jakarta.activation-api</artifactId>
-          <version>${jakarta.activation.version}</version>
-        </dependency>
-      </dependencies>
-    </profile>
-
     <!-- docker profile for building image for Coherence Operator -->
     <profile>
       <id>docker</id>

diff --git a/src/main/java/com/oracle/coherence/demo/application/BootstrapInterceptor.java b/src/main/java/com/oracle/coherence/demo/application/BootstrapInterceptor.java
@@ -38,6 +38,12 @@
 public class BootstrapInterceptor
         implements EventInterceptor<LifecycleEvent> {
 
+    /**
+     * Constructs a {@link BootstrapInterceptor}.
+     */
+    public BootstrapInterceptor() {
+    }
+
     @Override
     public void onEvent(LifecycleEvent event) {
         if (event.getType() == LifecycleEvent.Type.ACTIVATED) {

diff --git a/src/main/java/com/oracle/coherence/demo/application/DeveloperResource.java b/src/main/java/com/oracle/coherence/demo/application/DeveloperResource.java
@@ -59,6 +59,12 @@ public class DeveloperResource {
      */
     private static final String SECONDARY_CLUSTER = System.getProperty(Launcher.SECONDARY_CLUSTER_PROPERTY);
 
+    /**
+     * Constructs a {@link DeveloperResource}.
+     */
+    public DeveloperResource() {
+    }
+
     /**
      * Return the environment information for this Coherence cluster.
      *
@@ -108,8 +114,9 @@ public Response getResourceInsert(@PathParam("count") int count) {
     }
 
     /**
-     * Insert a number of positions based on the input argument.
+     * Insert a number of positions for the symbol based on the input argument.
      *
+     * @param symbol the symbol to insert
      * @param count  the number of positions to create
      *
      * @return {@link Response#ok}

diff --git a/src/main/java/com/oracle/coherence/demo/application/EventsResource.java b/src/main/java/com/oracle/coherence/demo/application/EventsResource.java
@@ -75,6 +75,11 @@ private OutboundSseEvent createEvent(String name, Price price) {
                   .build();
     }
 
+    /**
+     * Registers an event listener for the specified {@link SseEventSink}.
+     *
+     * @param eventSink  provided {@link SseEventSink}
+     */
     @GET
     @Path("subscribe")
     @Produces(MediaType.SERVER_SENT_EVENTS)

diff --git a/src/main/java/com/oracle/coherence/demo/application/ManagementResource.java b/src/main/java/com/oracle/coherence/demo/application/ManagementResource.java
@@ -63,7 +63,7 @@
  * <li>Query via - /jmx/query/Coherence:type=Service,* &#47;*</li>
  * <li>Run a report - /jmx/run-report/report-name</li>
  * </ul>
- * When you run a report using http://127.0.0.1:8080/service/jmx/run-report/report-cache-size
+ * When you run a report using <code>http://127.0.0.1:8080/service/jmx/run-report/report-cache-size</code>
  * The report name gets a prefix of reports/ and also xml added, so effectively you run
  * "reports/report-cache-size.xml"
  * <p>

diff --git a/src/main/java/com/oracle/coherence/demo/application/ManagementResourceConfig.java b/src/main/java/com/oracle/coherence/demo/application/ManagementResourceConfig.java
@@ -1,7 +1,7 @@
 /*
  * File: ManagementResourceConfig.java
  *
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2024 Oracle and/or its affiliates.
  *
  * You may not use this file except in compliance with the Universal Permissive
  * License (UPL), Version 1.0 (the "License.")
@@ -30,6 +30,9 @@
 public class ManagementResourceConfig
         extends ResourceConfig {
 
+    /**
+     * Constructs a {@link ManagementResourceConfig}.
+     */
     public ManagementResourceConfig() {
         RestManagement.configure(this);
     }

diff --git a/src/main/java/com/oracle/coherence/demo/cachestore/JpaCacheStore.java b/src/main/java/com/oracle/coherence/demo/cachestore/JpaCacheStore.java
@@ -1,7 +1,7 @@
 /*
  * File: JpaCacheStore.java
  *
- * Copyright (c) 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2020, 2024 Oracle and/or its affiliates.
  *
  * You may not use this file except in compliance with the Universal Permissive
  * License (UPL), Version 1.0 (the "License.")
@@ -155,6 +155,10 @@ public void eraseAll(Collection keys) {
         }
     }
 
+    /**
+     * Rollback the transaction.
+     * @param tx the transaction
+     */
     protected void rollback(EntityTransaction tx) {
         try {
             if (tx != null && tx.isActive()) {

diff --git a/src/main/java/com/oracle/coherence/demo/model/TradeSummary.java b/src/main/java/com/oracle/coherence/demo/model/TradeSummary.java
@@ -30,7 +30,6 @@
 @PortableType(id = 1005)
 public class TradeSummary {
 
-
     /**
      * The total number of shares acquired for the {@link Trade}.
      */
@@ -46,6 +45,10 @@ public class TradeSummary {
      */
     private double purchaseValue;
 
+
+    /**
+     * Constructs a {@link TradeSummary}.
+     */
     public TradeSummary() {
     }