Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixup javadoc #138

Merged
merged 1 commit into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 18 additions & 72 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -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}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
@@ -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.")
Expand Down Expand Up @@ -30,6 +30,9 @@
public class ManagementResourceConfig
extends ResourceConfig {

/**
* Constructs a {@link ManagementResourceConfig}.
*/
public ManagementResourceConfig() {
RestManagement.configure(this);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -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.")
Expand Down Expand Up @@ -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()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
@PortableType(id = 1005)
public class TradeSummary {


/**
* The total number of shares acquired for the {@link Trade}.
*/
Expand All @@ -46,6 +45,10 @@ public class TradeSummary {
*/
private double purchaseValue;


/**
* Constructs a {@link TradeSummary}.
*/
public TradeSummary() {
}

Expand Down
Loading