Add nullability to package org.firebirdsql.jdbc

Author: mrotteveel

src/main/org/firebirdsql/ds/FBXAConnection.java

@@ -24,7 +24,7 @@ public final class FBXAConnection extends FBPooledConnection implements XAConnec
 
     private final WeakReference<FBManagedConnection> mc;
 
-    FBXAConnection(FBConnection connection) {
+    FBXAConnection(FBConnection connection) throws SQLException {
         super(connection);
         mc = new WeakReference<>(connection.getManagedConnection());
     }

src/main/org/firebirdsql/gds/ng/AbstractImmutableAttachProperties.java

@@ -48,6 +48,15 @@ protected AbstractImmutableAttachProperties(IAttachProperties<T> src) {
                 : unmodifiableMap(new HashMap<>(src.connectionPropertyValues()));
     }
 
+    /**
+     * Constructor for an empty immutable attach properties instance.
+     *
+     * @since 7
+     */
+    AbstractImmutableAttachProperties() {
+        propValues = Map.of();
+    }
+
     @Override
     public final @Nullable String getProperty(String name) {
         ConnectionProperty property = property(name);

src/main/org/firebirdsql/gds/ng/FbImmutableConnectionProperties.java

@@ -14,6 +14,8 @@
 public final class FbImmutableConnectionProperties extends AbstractImmutableAttachProperties<IConnectionProperties>
         implements IConnectionProperties {
 
+    private static final FbImmutableConnectionProperties EMPTY = new FbImmutableConnectionProperties();
+
     /**
      * Copy constructor for FbConnectionProperties.
      * <p>
@@ -28,6 +30,22 @@ public FbImmutableConnectionProperties(IConnectionProperties src) {
         super(src);
     }
 
+    /**
+     * Constructor for an empty immutable connection properties instance.
+     *
+     * @since 7
+     */
+    private FbImmutableConnectionProperties() {
+    }
+
+    /**
+     * @return a possibly cached empty immutable connection properties instance
+     * @since 7
+     */
+    public static FbImmutableConnectionProperties empty() {
+        return EMPTY;
+    }
+
     @Override
     public IConnectionProperties asImmutable() {
         // Immutable already, so just return this

src/main/org/firebirdsql/jdbc/AbstractFetcher.java

@@ -4,7 +4,7 @@
  SPDX-FileCopyrightText: Copyright 2002 Nikolay Samofatov
  SPDX-FileCopyrightText: Copyright 2003 Ryan Baldwin
  SPDX-FileCopyrightText: Copyright 2005 Gabriel Reid
- SPDX-FileCopyrightText: Copyright 2012-2024 Mark Rotteveel
+ SPDX-FileCopyrightText: Copyright 2012-2026 Mark Rotteveel
  SPDX-License-Identifier: LGPL-2.1-or-later
 */
 package org.firebirdsql.jdbc;
@@ -16,7 +16,6 @@
 import org.firebirdsql.gds.ng.fields.RowValue;
 import org.firebirdsql.jdbc.FBObjectListener.FetcherListener;
 import org.firebirdsql.util.InternalApi;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
 import java.sql.SQLException;
@@ -30,7 +29,6 @@
  * @since 6
  */
 @InternalApi
-@NullMarked
 abstract sealed class AbstractFetcher implements FBFetcher
         permits FBCachedFetcher, FBServerScrollFetcher, FBStatementFetcher {
 

src/main/org/firebirdsql/jdbc/AbstractFieldMetaData.java

@@ -19,7 +19,6 @@
 import org.firebirdsql.gds.ng.fields.RowDescriptor;
 import org.firebirdsql.jdbc.field.JdbcTypeConverter;
 import org.firebirdsql.util.InternalApi;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
 import java.sql.SQLException;
@@ -44,7 +43,6 @@
  * @since 3.0
  */
 @InternalApi
-@NullMarked
 public abstract class AbstractFieldMetaData implements Wrapper {
 
     private final RowDescriptor rowDescriptor;

src/main/org/firebirdsql/jdbc/AbstractStatement.java

@@ -14,7 +14,6 @@
 import org.firebirdsql.gds.ng.FbStatement;
 import org.firebirdsql.gds.ng.LockCloseable;
 import org.firebirdsql.util.InternalApi;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
 import java.sql.SQLException;
@@ -36,7 +35,6 @@
  * @since 6
  */
 @InternalApi
-@NullMarked
 public abstract class AbstractStatement implements Statement, FirebirdStatement {
 
     private static final AtomicInteger STATEMENT_ID_GENERATOR = new AtomicInteger();

src/main/org/firebirdsql/jdbc/Batch.java

@@ -3,7 +3,6 @@
 package org.firebirdsql.jdbc;
 
 import org.firebirdsql.gds.ng.fields.RowValue;
-import org.jspecify.annotations.NullMarked;
 
 import java.sql.BatchUpdateException;
 import java.sql.SQLException;
@@ -15,7 +14,6 @@
  * @author Mark Rotteveel
  * @since 5
  */
-@NullMarked
 interface Batch {
 
     /**

src/main/org/firebirdsql/jdbc/ClientInfoProvider.java

@@ -1,9 +1,10 @@
-// SPDX-FileCopyrightText: Copyright 2023-2025 Mark Rotteveel
+// SPDX-FileCopyrightText: Copyright 2023-2026 Mark Rotteveel
 // SPDX-License-Identifier: LGPL-2.1-or-later
 package org.firebirdsql.jdbc;
 
 import org.firebirdsql.gds.ISCConstants;
 import org.firebirdsql.gds.ng.FbExceptionBuilder;
+import org.jspecify.annotations.Nullable;
 
 import java.sql.ClientInfoStatus;
 import java.sql.SQLClientInfoException;
@@ -55,7 +56,7 @@ final class ClientInfoProvider {
     // Holds statement used for setting or retrieving client info properties.
     private final MetadataStatementHolder statementHolder;
     // if null, use DEFAULT_CLIENT_INFO_PROPERTIES
-    private Set<ClientInfoProperty> knownProperties;
+    private @Nullable Set<ClientInfoProperty> knownProperties;
 
     ClientInfoProvider(FBConnection connection) throws SQLException {
         connection.checkValidity();
@@ -154,7 +155,7 @@ Collection<ClientInfoProperty> getDefaultClientInfoProperties() {
      * Implementation of {@link FBConnection#getClientInfo(String)}.
      */
     @SuppressWarnings("SqlSourceToSinkFlow")
-    public String getClientInfo(String name) throws SQLException {
+    public @Nullable String getClientInfo(String name) throws SQLException {
         ClientInfoProperty property;
         try {
             property = ClientInfoProperty.parse(name);
@@ -270,6 +271,7 @@ public void setClientInfo(String name, String value) throws SQLException {
             SQLException forMessage = FbExceptionBuilder.forException(jb_clientInfoInvalidPropertyName)
                     .messageParameter(name)
                     .toSQLException();
+            //noinspection DataFlowIssue : null-check for robustness
             throw new SQLClientInfoException(forMessage.getMessage(), forMessage.getSQLState(),
                     forMessage.getErrorCode(),
                     Map.of(requireNonNullElse(name, "<null>"), ClientInfoStatus.REASON_UNKNOWN), e);
@@ -298,7 +300,7 @@ public void setClientInfo(Properties properties) throws SQLException {
         // Include USER_SESSION, and USER_TRANSACTION if not in auto-commit
         Predicate<ClientInfoProperty> includePropertyPredicate = property ->
                 USER_SESSION.equals(property.context) || !autoCommit && USER_TRANSACTION.equals(property.context);
-        var propertyValues = new HashMap<ClientInfoProperty, String>();
+        var propertyValues = new HashMap<ClientInfoProperty, @Nullable String>();
         // Populating with null to clear properties not included in parameter properties
         getKnownProperties().stream()
                 .filter(includePropertyPredicate)
@@ -316,7 +318,7 @@ public void setClientInfo(Properties properties) throws SQLException {
     }
 
     @SuppressWarnings("SqlSourceToSinkFlow")
-    private void executeSetClientInfo(Map<ClientInfoProperty, String> propertyValues) throws SQLException {
+    private void executeSetClientInfo(Map<ClientInfoProperty, @Nullable String> propertyValues) throws SQLException {
         QuoteStrategy quoteStrategy = connection.getQuoteStrategy();
         var sb = new StringBuilder("""
                 execute block
@@ -437,7 +439,7 @@ StringBuilder appendAsGetContext(StringBuilder sb, QuoteStrategy quoteStrategy)
          *         value to set, use {@code null} to set SQL {@code NULL}
          * @return {@code sb} for chaining calls
          */
-        StringBuilder appendAsSetContext(StringBuilder sb, QuoteStrategy quoteStrategy, String value) {
+        StringBuilder appendAsSetContext(StringBuilder sb, QuoteStrategy quoteStrategy, @Nullable String value) {
             // 30 = 16 (prefix) + 9 (6 quotes, 2 commas, and closing parenthesis) + space for five quotes to escape
             sb.ensureCapacity(
                     sb.length() + 30 + context.length() + name.length() + (value != null ? value.length() : 4));

src/main/org/firebirdsql/jdbc/DbMetadataMediator.java

@@ -10,7 +10,6 @@
 import org.firebirdsql.gds.ng.fields.RowDescriptorBuilder;
 import org.firebirdsql.util.FirebirdSupportInfo;
 import org.firebirdsql.util.InternalApi;
-import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.NullUnmarked;
 
 import java.nio.charset.StandardCharsets;
@@ -31,7 +30,6 @@
  * @since 4.0
  */
 @InternalApi
-@NullMarked
 public abstract class DbMetadataMediator {
 
     private static final DatatypeCoder datatypeCoder =
@@ -70,7 +68,7 @@ public static RowDescriptorBuilder newRowDescriptorBuilder(int size) {
      * @return GDSType of the current connection
      */
     @NullUnmarked
-    public abstract GDSType getGDSType();
+    public abstract GDSType getGDSType() throws SQLException;
 
     /**
      * @return value of the {@code useCatalogAsPackage} connection property if packages are supported, otherwise

src/main/org/firebirdsql/jdbc/FBBlob.java

@@ -64,7 +64,6 @@
  * </p>
  */
 @InternalApi
-@NullMarked
 public final class FBBlob implements FirebirdBlob, TransactionListener {
 
     private static final System.Logger logger = System.getLogger(FBBlob.class.getName());
@@ -649,7 +648,6 @@ public void copyCharacterStream(Reader reader) throws SQLException {
     }
 
     @Override
-    @NullMarked
     public void transactionStateChanged(FbTransaction transaction, TransactionState newState,
             TransactionState previousState) {
         if (newState == TransactionState.COMMITTED || newState == TransactionState.ROLLED_BACK) {