From 057482aa1d98fa73eebbb5af862668d0518a90c6 Mon Sep 17 00:00:00 2001 From: Tim Middleton Date: Fri, 4 Oct 2024 09:56:18 +0800 Subject: [PATCH] Fixup javadoc --- pom.xml | 90 ++++--------------- .../application/BootstrapInterceptor.java | 6 ++ .../demo/application/DeveloperResource.java | 9 +- .../demo/application/EventsResource.java | 5 ++ .../demo/application/ManagementResource.java | 2 +- .../application/ManagementResourceConfig.java | 5 +- .../demo/cachestore/JpaCacheStore.java | 6 +- .../coherence/demo/model/TradeSummary.java | 5 +- 8 files changed, 51 insertions(+), 77 deletions(-) diff --git a/pom.xml b/pom.xml index 327c94e..6f25d2b 100644 --- a/pom.xml +++ b/pom.xml @@ -74,6 +74,7 @@ false 127.0.0.1 8080 + none @@ -377,8 +378,9 @@ -Xmx512m -Xms512m - -Dcoherence.log.level=9 + -Dcoherence.log.level=5 -Dcoherence.management=all + -Dcoherence.management.http=${management.http} -Dcoherence.ttl=0 -Djava.net.preferIPv4Stack=true -Dcoherence.wka=127.0.0.1 @@ -406,6 +408,21 @@ + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin.version} + + + attach-javadocs + + jar + + + + @@ -460,77 +477,6 @@ - - - javadoc-jdk11 - - 11 - - - - - org.apache.maven.plugins - maven-compiler-plugin - ${maven.compiler.plugin.version} - - 8 - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - ${maven.javadoc.plugin.version} - - - attach-javadocs-jdk11 - - jar - - - - - - - jakarta.xml.bind - jakarta.xml.bind-api - ${jakarta.xml.bind.version} - - - jakarta.xml.bind - jaxb-impl - ${jakarta.xml.bind.version} - - - jakarta.xml.bind - jaxb-api - ${jakarta.xml.bind.version} - - - jakarta.activation - jakarta.activation-api - ${jakarta.activation.version} - - - - - - - - - jakarta.xml.bind - jakarta.xml.bind-api - ${jakarta.xml.bind.version} - - - jakarta.activation - jakarta.activation-api - ${jakarta.activation.version} - - - - docker diff --git a/src/main/java/com/oracle/coherence/demo/application/BootstrapInterceptor.java b/src/main/java/com/oracle/coherence/demo/application/BootstrapInterceptor.java index 09c6c18..ceed7b8 100644 --- 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 { + /** + * 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 index f1e3570..d885891 100644 --- 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 index 4255cc8..c4f8405 100644 --- 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 index df6e786..f08a8bd 100644 --- 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 @@ *
  • Query via - /jmx/query/Coherence:type=Service,* /*
    • *
  • Run a report - /jmx/run-report/report-name
    • * - * 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 http://127.0.0.1:8080/service/jmx/run-report/report-cache-size * The report name gets a prefix of reports/ and also xml added, so effectively you run * "reports/report-cache-size.xml" *

    diff --git a/src/main/java/com/oracle/coherence/demo/application/ManagementResourceConfig.java b/src/main/java/com/oracle/coherence/demo/application/ManagementResourceConfig.java index 757b430..54008b1 100644 --- 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 index f467fc6..cca7155 100644 --- 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 index 34e37a3..758cd66 100644 --- 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() { }