From 4519f45b3fd7ea95fa60122f47b0d093cd1acd16 Mon Sep 17 00:00:00 2001 From: Dave Cramer Date: Tue, 1 Feb 2022 07:52:07 -0500 Subject: [PATCH 1/3] fix javadoc failure to document parameters --- pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java b/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java index e4fec28fc4..4be4148038 100644 --- a/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java +++ b/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java @@ -23,6 +23,8 @@ public class ObjectFactory { * single String argument is searched if it fails, or tryString is true a no argument constructor * is tried. * + * @param expected class + * @param expectedClass expected class, if the class instantiated doesn't match this will fail * @param classname name of the class to instantiate * @param info parameter to pass as Properties * @param tryString whether to look for a single String argument constructor From 63a6a3da14c2ff6fb51d29e2ba7e51bee9a3531c Mon Sep 17 00:00:00 2001 From: Dave Cramer Date: Tue, 1 Feb 2022 08:44:15 -0500 Subject: [PATCH 2/3] fix checkstyle --- .../test/java/org/postgresql/test/util/ObjectFactoryTest.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pgjdbc/src/test/java/org/postgresql/test/util/ObjectFactoryTest.java b/pgjdbc/src/test/java/org/postgresql/test/util/ObjectFactoryTest.java index e0a9d1f4b4..d51e5c5701 100644 --- a/pgjdbc/src/test/java/org/postgresql/test/util/ObjectFactoryTest.java +++ b/pgjdbc/src/test/java/org/postgresql/test/util/ObjectFactoryTest.java @@ -5,9 +5,9 @@ package org.postgresql.test.util; -import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; import org.postgresql.PGProperty; import org.postgresql.jdbc.SslMode; @@ -15,8 +15,8 @@ import org.postgresql.util.ObjectFactory; import org.postgresql.util.PSQLState; -import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; import org.opentest4j.MultipleFailuresError; import java.sql.SQLException; From 9a245ce0926542eebacd7430ac2c2a93bc311112 Mon Sep 17 00:00:00 2001 From: Dave Cramer Date: Tue, 1 Feb 2022 09:46:18 -0500 Subject: [PATCH 3/3] more javadoc fixes --- pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java b/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java index 4be4148038..b927e8777c 100644 --- a/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java +++ b/pgjdbc/src/main/java/org/postgresql/util/ObjectFactory.java @@ -23,8 +23,9 @@ public class ObjectFactory { * single String argument is searched if it fails, or tryString is true a no argument constructor * is tried. * - * @param expected class - * @param expectedClass expected class, if the class instantiated doesn't match this will fail + * @param type of expected class + * @param expectedClass expected class of type T, if the classname instantiated doesn't match + * the expected type of this class this method will fail * @param classname name of the class to instantiate * @param info parameter to pass as Properties * @param tryString whether to look for a single String argument constructor