pg.ddx.io  GitHub: pgjdbc/pgjdbc (issues + PRs as email threads)  
help / color / mirror / Atom feed
From: HimanshuJha-2005 (@HimanshuJha-2005) <noreply+HimanshuJha-2005@github.com>
To: pgjdbc/pgjdbc <noreply+pgjdbc-pgjdbc@github.com>
Subject: [pgjdbc/pgjdbc] PR #4522: fix: override toString in PgSQLXML to return formatted string
Date: Thu, 05 Nov 2026 09:16:34 +0000
Message-ID: <gh-pgjdbc-pgjdbc-4522@github.com> (raw)

### Description
Overrides `toString()` on `PgSQLXML` to return the formatted XML string matching `getString()`.

When the object is uninitialized, already freed, or encounters a data decode failure where `getString()` raises a `SQLException`, `toString()` catches the exception and falls back to `super.toString()`.

Fixes #1689

### Verification
- Added standalone unit tests in `PgSQLXMLUnitTest` covering initialized XML strings, null payloads, uninitialized fallback, freed object fallback, and `setString` mutations.
- Updated `PgSQLXMLTest` to assert `toString()` parity against live queries.
- Verified `./gradlew style` passed with zero violations.

inline patch 1: pgjdbc/src/main/java/org/postgresql/jdbc/PgSQLXML.java, pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLTest.java, pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLUnitTest.java (+77/-0 lines) download inline-1.patchdiff --git a/pgjdbc/src/main/java/org/postgresql/jdbc/PgSQLXML.java b/pgjdbc/src/main/java/org/postgresql/jdbc/PgSQLXML.java index 2431879c40..a4878f6b72 100644 --- a/pgjdbc/src/main/java/org/postgresql/jdbc/PgSQLXML.java +++ b/pgjdbc/src/main/java/org/postgresql/jdbc/PgSQLXML.java @@ -184,6 +184,16 @@ public void free() { } } + @Override + @SuppressWarnings("nullness") + public String toString() { + try { + return getString(); + } catch (SQLException e) { + return super.toString(); + } + } + @Override public OutputStream setBinaryStream() throws SQLException { try (ResourceLock ignore = lock.obtain()) { diff --git a/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLTest.java b/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLTest.java index c2ea1af228..913d01d29d 100644 --- a/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLTest.java +++ b/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLTest.java @@ -73,6 +73,15 @@ public void setCharacterStream() throws Exception { SQLXML result = rs.getSQLXML(1); assertNotNull(result); assertEquals(example, result.getString()); + assertEquals(example, result.toString()); + } + + @Test + public void testToString() throws Exception { + String example = "<x>value</x>"; + SQLXML pgSQLXML = con.createSQLXML(); + pgSQLXML.setString(example); + assertEquals(example, pgSQLXML.toString()); } private static final String LICENSE_URL = diff --git a/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLUnitTest.java b/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLUnitTest.java new file mode 100644 index 0000000000..3bc41dd964 --- /dev/null +++ b/pgjdbc/src/test/java/org/postgresql/jdbc/PgSQLXMLUnitTest.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2026, PostgreSQL Global Development Group + * See the LICENSE file in the project root for more information. + */ + +package org.postgresql.jdbc; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.api.Test; + +import java.sql.SQLException; + +class PgSQLXMLUnitTest { + + @Test + void testToStringInitializedWithString() throws SQLException { + String xmlData = "<root><item id=\"1\">test</item></root>"; + PgSQLXML xml = new PgSQLXML(null, xmlData); + assertEquals(xmlData, xml.getString()); + assertEquals(xmlData, xml.toString()); + } + + @Test + void testToStringInitializedWithNull() throws SQLException { + PgSQLXML xml = new PgSQLXML(null, null); + assertNull(xml.getString()); + assertNull(xml.toString()); + } + + @Test + void testToStringUninitializedFallsBackToDefault() { + PgSQLXML xml = new PgSQLXML(null); + String str = xml.toString(); + assertTrue(str.startsWith("org.postgresql.jdbc.PgSQLXML@"), + "Uninitialized PgSQLXML.toString() should fall back to Object.toString()"); + } + + @Test + void testToStringFreedFallsBackToDefault() throws SQLException { + PgSQLXML xml = new PgSQLXML(null, "<data/>"); + xml.free(); + String str = xml.toString(); + assertTrue(str.startsWith("org.postgresql.jdbc.PgSQLXML@"), + "Freed PgSQLXML.toString() should fall back to Object.toString()"); + } + + @Test + void testToStringAfterSetString() throws SQLException { + PgSQLXML xml = new PgSQLXML(null); + String xmlData = "<message>hello</message>"; + xml.setString(xmlData); + assertEquals(xmlData, xml.getString()); + assertEquals(xmlData, xml.toString()); + } +}

Message-ID: <gh-pgjdbc-pgjdbc-4522@github.com>
Permalink:  ../gh-pgjdbc-pgjdbc-4522@github.com/

 ·  · 


This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox