From 43f21c0fd37fdf962b12135206f27d5c9fdd30b7 Mon Sep 17 00:00:00 2001 From: Brett Wooldridge Date: Wed, 11 Apr 2018 01:57:52 +0900 Subject: [PATCH] Fix JavaDoc typo --- .../java/com/zaxxer/hikari/HikariPoolMXBean.java | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/zaxxer/hikari/HikariPoolMXBean.java b/src/main/java/com/zaxxer/hikari/HikariPoolMXBean.java index d725c43d..bdc8a07a 100644 --- a/src/main/java/com/zaxxer/hikari/HikariPoolMXBean.java +++ b/src/main/java/com/zaxxer/hikari/HikariPoolMXBean.java @@ -26,16 +26,24 @@ import javax.sql.DataSource; public interface HikariPoolMXBean { /** - * Get the number of currently idle connections in the pool. The return value is extremely transient and is - * a point-in-time measurement. + * Get the number of currently idle connections in the pool. + *

+ * The return value is extremely transient and is a point-in-time measurement. Therefore, due to a time + * difference between invoking this method and {@link #getActiveConnections()}, it is possible for the sum + * of idle plus active connections to be either less than or greater than the value returned by + * {@link #getTotalConnections()}. * * @return the current number of idle connections in the pool */ int getIdleConnections(); /** - * Get the number of currently active connections in the pool. The return value is extremely transient and is - * a point-in-time measurement. + * Get the number of currently active connections in the pool. + *

+ * The return value is extremely transient and is a point-in-time measurement. Therefore, due to a time + * difference between invoking this method and {@link #getIdleConnections()}, it is possible for the sum + * of idle plus active connections to be either less than or greater than the value returned by + * {@link #getTotalConnections()}. * * @return the current number of active (in-use) connections in the pool */