Fix javadoc warnings/errors (#1480)

Author: aaron-congo

wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginFactory.java

@@ -23,8 +23,8 @@
  * Interface for connection plugin factories. This class implements ways to initialize a connection
  * plugin.
  *
- * @apiNote Consider using {@link ServicesContainerPluginFactory} for new implementations as it provides access to all
- *     services in the {@link FullServicesContainer}.
+ * <p>Note: consider using {@link ServicesContainerPluginFactory} for new implementations as it provides access to all
+ * services in the {@link FullServicesContainer}.
  */
 public interface ConnectionPluginFactory {
 

wrapper/src/main/java/software/amazon/jdbc/plugin/customendpoint/CustomEndpointPlugin.java

@@ -209,6 +209,7 @@ public Connection connect(
    *
    * @param props The connection properties.
    * @return {@link CustomEndpointMonitor}
+   * @throws SQLException if an error occurs while attempting to create the monitor.
    */
   protected CustomEndpointMonitor createMonitorIfAbsent(Properties props) throws SQLException {
     return this.servicesContainer.getMonitorService().runIfAbsent(

wrapper/src/main/java/software/amazon/jdbc/util/connection/ConnectionService.java

@@ -30,6 +30,7 @@ public interface ConnectionService {
    * @param hostSpec the hostSpec containing the host information for the auxiliary connection.
    * @param props    the properties for the auxiliary connection.
    * @return a new connection to the given host using the given props.
+   * @throws SQLException if an error occurs while opening the connection.
    */
   Connection open(HostSpec hostSpec, Properties props) throws SQLException;
 

wrapper/src/main/java/software/amazon/jdbc/util/monitoring/MonitorService.java

@@ -40,6 +40,7 @@ public interface MonitorService {
    *                               last-updated timestamp within this duration it will be considered stuck.
    * @param errorResponses         a {@link Set} defining actions to take if the monitor is stuck or in an error state.
    * @param producedDataClass      the class of data produced by the monitor.
+   * @param <T>                    the type of the monitor.
    */
   <T extends Monitor> void registerMonitorTypeIfAbsent(
       Class<T> monitorClass,
@@ -52,18 +53,20 @@ <T extends Monitor> void registerMonitorTypeIfAbsent(
    * Creates and starts the given monitor if it does not already exist and stores it under the given monitor type and
    * key. If the monitor already exists, its expiration time will be renewed, even if it was already expired.
    *
-   * @param monitorClass the concrete class of the monitor, eg `CustomEndpointMonitorImpl.class`.
-   * @param key          the key for the monitor, eg
-   *                     "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
-   * @param storageService the storage service for the monitor to use.
+   * @param monitorClass     the concrete class of the monitor, eg `CustomEndpointMonitorImpl.class`.
+   * @param key              the key for the monitor, eg
+   *                         "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
+   * @param storageService   the storage service for the monitor to use.
    * @param telemetryFactory the telemetry factory for creating telemetry data.
-   * @param originalUrl the URL of the original database connection.
-   * @param driverProtocol the protocol for the underlying target driver.
-   * @param driverDialect the target driver dialect.
-   * @param dbDialect the database dialect.
-   * @param originalProps the properties of the original database connection.
-   * @param initializer an initializer function to use to create the monitor if it does not already exist.
+   * @param originalUrl      the URL of the original database connection.
+   * @param driverProtocol   the protocol for the underlying target driver.
+   * @param driverDialect    the target driver dialect.
+   * @param dbDialect        the database dialect.
+   * @param originalProps    the properties of the original database connection.
+   * @param initializer      an initializer function to use to create the monitor if it does not already exist.
+   * @param <T>              the type of the monitor.
    * @return the new or existing monitor.
+   * @throws SQLException if an error occurs while trying to create the monitor.
    */
   <T extends Monitor> T runIfAbsent(
       Class<T> monitorClass,
@@ -82,6 +85,7 @@ <T extends Monitor> T runIfAbsent(
    *
    * @param monitorClass the expected class of the monitor.
    * @param key          the key for the monitor.
+   * @param <T>          the type of the monitor.
    * @return the monitor stored at the given key.
    */
   @Nullable
@@ -93,6 +97,7 @@ <T extends Monitor> T runIfAbsent(
    *
    * @param monitorClass the expected class of the monitor.
    * @param key          the key for the monitor.
+   * @param <T>          the type of the monitor.
    * @return the monitor that was removed. Returns null if there was no monitor at the given key or the expected monitor
    *     class did not match the actual monitor class.
    */
@@ -105,13 +110,15 @@ <T extends Monitor> T runIfAbsent(
    * @param monitorClass the class of the monitor, eg `CustomEndpointMonitorImpl.class`.
    * @param key          the key for the monitor, eg
    *                     "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
+   * @param <T>          the type of the monitor.
    */
   <T extends Monitor> void stopAndRemove(Class<T> monitorClass, Object key);
 
   /**
    * Stops all monitors for the given type and removes them from the monitor service.
    *
    * @param monitorClass the class of the monitor, eg `CustomEndpointMonitorImpl.class`.
+   * @param <T>          the type of the monitor.
    */
   <T extends Monitor> void stopAndRemoveMonitors(Class<T> monitorClass);
 

wrapper/src/main/java/software/amazon/jdbc/util/storage/CacheItem.java

@@ -66,6 +66,9 @@ protected boolean isExpired() {
 
   /**
    * Renews a cache item's expiration time.
+   *
+   * @param timeToLiveNanos the duration that the item should sit in the cache before being considered expired, in
+   *                        nanoseconds.
    */
   protected void extendExpiration(long timeToLiveNanos) {
     this.expirationTimeNanos = System.nanoTime() + timeToLiveNanos;