Add org.apache.commons.pool2.PooledObject.nonNull(PooledObject)

Author: garydgregory

src/main/java/org/apache/commons/pool3/PooledObject.java

@@ -44,6 +44,17 @@ static boolean isNull(final PooledObject<?> pooledObject) {
         return pooledObject == null || pooledObject.getObject() == null;
     }
 
+    /**
+     * Tests whether the given PooledObject isn't null <em>and</em> doesn't wraps a null.
+     *
+     * @param pooledObject the PooledObject to test.
+     * @return whether the given PooledObject isn't null <em>and</em> doesn't wraps a null.
+     * @since 2.13.0
+     */
+    static boolean nonNull(final PooledObject<?> pooledObject) {
+        return pooledObject != null && pooledObject.getObject() != null;
+    }
+
     /**
      * Allocates the object.
      *

src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java

@@ -299,7 +299,7 @@ public GenericKeyedObjectPool(final KeyedPooledObjectFactory<K, T, E> factory,
      * @throws E If the associated factory fails to passivate the object
      */
     private void addIdleObject(final K key, final PooledObject<T> p) throws E {
-        if (!PooledObject.isNull(p)) {
+        if (PooledObject.nonNull(p)) {
             factory.passivateObject(key, p);
             final LinkedBlockingDeque<PooledObject<T>> idleObjects = poolMap.get(key).getIdleObjects();
             if (getLifo()) {
@@ -436,7 +436,7 @@ public T borrowObject(final K key, final long borrowMaxWaitMillis) throws E {
                 p = objectDeque.getIdleObjects().pollFirst();
                 if (p == null) {
                     p = create(key);
-                    if (!PooledObject.isNull(p)) {
+                    if (PooledObject.nonNull(p)) {
                         create = true;
                     }
                 }

src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java

@@ -193,7 +193,7 @@ public GenericObjectPool(final PooledObjectFactory<T, E> factory,
      * @throws E If the factory fails to passivate the object
      */
     private void addIdleObject(final PooledObject<T> p) throws E {
-        if (!PooledObject.isNull(p)) {
+        if (PooledObject.nonNull(p)) {
             factory.passivateObject(p);
             if (getLifo()) {
                 idleObjects.addFirst(p);
@@ -303,7 +303,7 @@ public T borrowObject(final Duration maxWaitDuration) throws E {
             p = idleObjects.pollFirst();
             if (p == null) {
                 p = create(remainingWaitDuration);
-                if (!PooledObject.isNull(p)) {
+                if (PooledObject.nonNull(p)) {
                     create = true;
                 }
             }

src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java

@@ -413,7 +413,7 @@ public PooledObject<T> makeObject() throws E {
         final MakeEvent makeEvent = new MakeEvent();
         try {
             final PooledObject<T> obj = factory.makeObject();
-            makeEvent.setSuccess(!PooledObject.isNull(obj));
+            makeEvent.setSuccess(PooledObject.nonNull(obj));
             return obj;
         } catch (final Throwable t) {
             makeEvent.setSuccess(false);

src/test/java/org/apache/commons/pool3/PooledObjectTest.java

@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.pool3;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.apache.commons.pool3.impl.DefaultPooledObject;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link PooledObject}.
+ */
+public class PooledObjectTest {
+
+    @Test
+    void testIsNull() {
+        assertTrue(PooledObject.isNull(null));
+        assertTrue(PooledObject.isNull(new DefaultPooledObject<>(null)));
+        assertFalse(PooledObject.isNull(new DefaultPooledObject<>("a")));
+    }
+
+    @Test
+    void testNonNull() {
+        assertFalse(PooledObject.nonNull(null));
+        assertFalse(PooledObject.nonNull(new DefaultPooledObject<>(null)));
+        assertTrue(PooledObject.nonNull(new DefaultPooledObject<>("a")));
+    }
+}

src/test/java/org/apache/commons/pool3/pool407/AbstractKeyedPool407Factory.java

@@ -30,7 +30,7 @@ public abstract class AbstractKeyedPool407Factory extends BaseKeyedPooledObjectF
     @Override
     public boolean validateObject(final String key, final PooledObject<KeyedPool407Fixture> p) {
         // TODO Should this be enough even if wrap() does throw and returns a DefaultPooledObject wrapping a null?
-        return !PooledObject.isNull(p);
+        return PooledObject.nonNull(p);
     }
 
 }

src/test/java/org/apache/commons/pool3/pool407/AbstractPool407Factory.java

@@ -43,7 +43,7 @@ public abstract class AbstractPool407Factory extends BasePooledObjectFactory<Poo
     @Override
     public boolean validateObject(final PooledObject<Pool407Fixture> p) {
         // TODO Should this be enough even if wrap() does throw and returns a DefaultPooledObject wrapping a null?
-        return !PooledObject.isNull(p);
+        return PooledObject.isNull(p);
     }
 
 }