This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
commit 155243ab363e82c5b84edd8f4416ba7f1a2fd10c
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Feb 15 14:03:12 2021 -0500
Sort members.
---
.../apache/commons/pool2/impl/AbandonedConfig.java | 270 ++++++++++-----------
1 file changed, 135 insertions(+), 135 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
index 36f7c9a..0f0b94e 100644
--- a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
@@ -40,6 +40,72 @@ public class AbandonedConfig {
private boolean removeAbandonedOnBorrow;
/**
+ * Whether or not pool maintenance (evictor) performs abandoned object
+ * removal.
+ */
+ private boolean removeAbandonedOnMaintenance;
+
+ /**
+ * Timeout before an abandoned object can be removed.
+ */
+ private Duration removeAbandonedTimeout = DEFAULT_REMOVE_ABANDONED_TIMEOUT;
+
+ /**
+ * Determines whether or not to log stack traces for application code
+ * which abandoned an object.
+ */
+ private boolean logAbandoned = false;
+
+ /**
+ * Determines whether or not to log full stack traces when logAbandoned is
true.
+ * If disabled, then a faster method for logging stack traces with only
class data
+ * may be used if possible.
+ *
+ * @since 2.5
+ */
+ private boolean requireFullStackTrace = true;
+
+ /**
+ * PrintWriter to use to log information on abandoned objects.
+ * Use of default system encoding is deliberate.
+ */
+ private PrintWriter logWriter = new PrintWriter(new
OutputStreamWriter(System.out, Charset.defaultCharset()));
+
+ /**
+ * If the pool implements {@link UsageTracking}, should the pool record a
+ * stack trace every time a method is called on a pooled object and retain
+ * the most recent stack trace to aid debugging of abandoned objects?
+ */
+ private boolean useUsageTracking = false;
+
+ /**
+ * Flag to log stack traces for application code which abandoned
+ * an object.
+ *
+ * Defaults to false.
+ * Logging of abandoned objects adds overhead for every object created
+ * because a stack trace has to be generated.
+ *
+ * @return boolean true if stack trace logging is turned on for abandoned
+ * objects
+ *
+ */
+ public boolean getLogAbandoned() {
+ return this.logAbandoned;
+ }
+
+ /**
+ * Returns the log writer being used by this configuration to log
+ * information on abandoned objects. If not set, a PrintWriter based on
+ * System.out with the system default encoding is used.
+ *
+ * @return log writer in use
+ */
+ public PrintWriter getLogWriter() {
+ return logWriter;
+ }
+
+ /**
* <p>Flag to remove abandoned objects if they exceed the
* removeAbandonedTimeout when borrowObject is invoked.</p>
*
@@ -57,24 +123,6 @@ public class AbandonedConfig {
/**
* <p>Flag to remove abandoned objects if they exceed the
- * removeAbandonedTimeout when borrowObject is invoked.</p>
- *
- * @param removeAbandonedOnBorrow true means abandoned objects will be
- * removed by borrowObject
- * @see #getRemoveAbandonedOnBorrow()
- */
- public void setRemoveAbandonedOnBorrow(final boolean
removeAbandonedOnBorrow) {
- this.removeAbandonedOnBorrow = removeAbandonedOnBorrow;
- }
-
- /**
- * Whether or not pool maintenance (evictor) performs abandoned object
- * removal.
- */
- private boolean removeAbandonedOnMaintenance;
-
- /**
- * <p>Flag to remove abandoned objects if they exceed the
* removeAbandonedTimeout when pool maintenance (the "evictor")
* runs.</p>
*
@@ -93,23 +141,6 @@ public class AbandonedConfig {
}
/**
- * <p>Flag to remove abandoned objects if they exceed the
- * removeAbandonedTimeout when pool maintenance runs.</p>
- *
- * @param removeAbandonedOnMaintenance true means abandoned objects will be
- * removed by pool maintenance
- * @see #getRemoveAbandonedOnMaintenance
- */
- public void setRemoveAbandonedOnMaintenance(final boolean
removeAbandonedOnMaintenance) {
- this.removeAbandonedOnMaintenance = removeAbandonedOnMaintenance;
- }
-
- /**
- * Timeout before an abandoned object can be removed.
- */
- private Duration removeAbandonedTimeout = DEFAULT_REMOVE_ABANDONED_TIMEOUT;
-
- /**
* <p>Timeout in seconds before an abandoned object can be removed.</p>
*
* <p>The time of most recent use of an object is the maximum (latest) of
@@ -143,60 +174,29 @@ public class AbandonedConfig {
}
/**
- * <p>Sets the timeout before an abandoned object can be
- * removed</p>
- *
- * <p>Setting this property has no effect if
- * {@link #getRemoveAbandonedOnBorrow() removeAbandonedOnBorrow} and
- * {@link #getRemoveAbandonedOnMaintenance() removeAbandonedOnMaintenance}
- * are both false.</p>
- *
- * @param removeAbandonedTimeout new abandoned timeout
- * @see #getRemoveAbandonedTimeout()
- * @since 2.10.0
- */
- public void setRemoveAbandonedTimeout(final Duration
removeAbandonedTimeout) {
- this.removeAbandonedTimeout = removeAbandonedTimeout;
- }
-
- /**
- * <p>Sets the timeout in seconds before an abandoned object can be
- * removed</p>
- *
- * <p>Setting this property has no effect if
- * {@link #getRemoveAbandonedOnBorrow() removeAbandonedOnBorrow} and
- * {@link #getRemoveAbandonedOnMaintenance() removeAbandonedOnMaintenance}
- * are both false.</p>
+ * Indicates if full stack traces are required when {@link
#getLogAbandoned() logAbandoned}
+ * is true. Defaults to true. Logging of abandoned objects requiring a
full stack trace will
+ * generate an entire stack trace to generate for every object created. If
this is disabled,
+ * a faster but less informative stack walking mechanism may be used if
available.
*
- * @param removeAbandonedTimeout new abandoned timeout in seconds
- * @see #getRemoveAbandonedTimeout()
- * @deprecated Use {@link #setRemoveAbandonedTimeout(Duration)}.
+ * @return true if full stack traces are required for logging abandoned
connections, or false
+ * if abbreviated stack traces are acceptable
+ * @see CallStack
+ * @since 2.5
*/
- @Deprecated
- public void setRemoveAbandonedTimeout(final int removeAbandonedTimeout) {
- setRemoveAbandonedTimeout(Duration.ofSeconds(removeAbandonedTimeout));
+ public boolean getRequireFullStackTrace() {
+ return requireFullStackTrace;
}
/**
- * Determines whether or not to log stack traces for application code
- * which abandoned an object.
- */
- private boolean logAbandoned = false;
-
- /**
- * Flag to log stack traces for application code which abandoned
- * an object.
- *
- * Defaults to false.
- * Logging of abandoned objects adds overhead for every object created
- * because a stack trace has to be generated.
- *
- * @return boolean true if stack trace logging is turned on for abandoned
- * objects
+ * If the pool implements {@link UsageTracking}, should the pool record a
+ * stack trace every time a method is called on a pooled object and retain
+ * the most recent stack trace to aid debugging of abandoned objects?
*
+ * @return {@code true} if usage tracking is enabled
*/
- public boolean getLogAbandoned() {
- return this.logAbandoned;
+ public boolean getUseUsageTracking() {
+ return useUsageTracking;
}
/**
@@ -212,85 +212,85 @@ public class AbandonedConfig {
}
/**
- * Determines whether or not to log full stack traces when logAbandoned is
true.
- * If disabled, then a faster method for logging stack traces with only
class data
- * may be used if possible.
+ * Sets the log writer to be used by this configuration to log
+ * information on abandoned objects.
*
- * @since 2.5
+ * @param logWriter The new log writer
*/
- private boolean requireFullStackTrace = true;
+ public void setLogWriter(final PrintWriter logWriter) {
+ this.logWriter = logWriter;
+ }
/**
- * Indicates if full stack traces are required when {@link
#getLogAbandoned() logAbandoned}
- * is true. Defaults to true. Logging of abandoned objects requiring a
full stack trace will
- * generate an entire stack trace to generate for every object created. If
this is disabled,
- * a faster but less informative stack walking mechanism may be used if
available.
+ * <p>Flag to remove abandoned objects if they exceed the
+ * removeAbandonedTimeout when borrowObject is invoked.</p>
*
- * @return true if full stack traces are required for logging abandoned
connections, or false
- * if abbreviated stack traces are acceptable
- * @see CallStack
- * @since 2.5
+ * @param removeAbandonedOnBorrow true means abandoned objects will be
+ * removed by borrowObject
+ * @see #getRemoveAbandonedOnBorrow()
*/
- public boolean getRequireFullStackTrace() {
- return requireFullStackTrace;
+ public void setRemoveAbandonedOnBorrow(final boolean
removeAbandonedOnBorrow) {
+ this.removeAbandonedOnBorrow = removeAbandonedOnBorrow;
}
/**
- * Sets the flag to require full stack traces for logging abandoned
connections when enabled.
+ * <p>Flag to remove abandoned objects if they exceed the
+ * removeAbandonedTimeout when pool maintenance runs.</p>
*
- * @param requireFullStackTrace indicates whether or not full stack traces
are required in
- * abandoned connection logs
- * @see CallStack
- * @see #getRequireFullStackTrace()
- * @since 2.5
+ * @param removeAbandonedOnMaintenance true means abandoned objects will be
+ * removed by pool maintenance
+ * @see #getRemoveAbandonedOnMaintenance
*/
- public void setRequireFullStackTrace(final boolean requireFullStackTrace) {
- this.requireFullStackTrace = requireFullStackTrace;
+ public void setRemoveAbandonedOnMaintenance(final boolean
removeAbandonedOnMaintenance) {
+ this.removeAbandonedOnMaintenance = removeAbandonedOnMaintenance;
}
/**
- * PrintWriter to use to log information on abandoned objects.
- * Use of default system encoding is deliberate.
- */
- private PrintWriter logWriter = new PrintWriter(new
OutputStreamWriter(System.out, Charset.defaultCharset()));
-
- /**
- * Returns the log writer being used by this configuration to log
- * information on abandoned objects. If not set, a PrintWriter based on
- * System.out with the system default encoding is used.
+ * <p>Sets the timeout before an abandoned object can be
+ * removed</p>
*
- * @return log writer in use
+ * <p>Setting this property has no effect if
+ * {@link #getRemoveAbandonedOnBorrow() removeAbandonedOnBorrow} and
+ * {@link #getRemoveAbandonedOnMaintenance() removeAbandonedOnMaintenance}
+ * are both false.</p>
+ *
+ * @param removeAbandonedTimeout new abandoned timeout
+ * @see #getRemoveAbandonedTimeout()
+ * @since 2.10.0
*/
- public PrintWriter getLogWriter() {
- return logWriter;
+ public void setRemoveAbandonedTimeout(final Duration
removeAbandonedTimeout) {
+ this.removeAbandonedTimeout = removeAbandonedTimeout;
}
/**
- * Sets the log writer to be used by this configuration to log
- * information on abandoned objects.
+ * <p>Sets the timeout in seconds before an abandoned object can be
+ * removed</p>
*
- * @param logWriter The new log writer
+ * <p>Setting this property has no effect if
+ * {@link #getRemoveAbandonedOnBorrow() removeAbandonedOnBorrow} and
+ * {@link #getRemoveAbandonedOnMaintenance() removeAbandonedOnMaintenance}
+ * are both false.</p>
+ *
+ * @param removeAbandonedTimeout new abandoned timeout in seconds
+ * @see #getRemoveAbandonedTimeout()
+ * @deprecated Use {@link #setRemoveAbandonedTimeout(Duration)}.
*/
- public void setLogWriter(final PrintWriter logWriter) {
- this.logWriter = logWriter;
+ @Deprecated
+ public void setRemoveAbandonedTimeout(final int removeAbandonedTimeout) {
+ setRemoveAbandonedTimeout(Duration.ofSeconds(removeAbandonedTimeout));
}
/**
- * If the pool implements {@link UsageTracking}, should the pool record a
- * stack trace every time a method is called on a pooled object and retain
- * the most recent stack trace to aid debugging of abandoned objects?
- */
- private boolean useUsageTracking = false;
-
- /**
- * If the pool implements {@link UsageTracking}, should the pool record a
- * stack trace every time a method is called on a pooled object and retain
- * the most recent stack trace to aid debugging of abandoned objects?
+ * Sets the flag to require full stack traces for logging abandoned
connections when enabled.
*
- * @return {@code true} if usage tracking is enabled
+ * @param requireFullStackTrace indicates whether or not full stack traces
are required in
+ * abandoned connection logs
+ * @see CallStack
+ * @see #getRequireFullStackTrace()
+ * @since 2.5
*/
- public boolean getUseUsageTracking() {
- return useUsageTracking;
+ public void setRequireFullStackTrace(final boolean requireFullStackTrace) {
+ this.requireFullStackTrace = requireFullStackTrace;
}
/**
