-
- All Known Implementing Classes:
- SQLOutputImpl
public interface SQLOutput
The output stream for writing the attributes of a user-defined type back to the database. This interface, used only for custom mapping, is used by the driver, and its methods are never directly invoked by a programmer.When an object of a class implementing the interface
SQLData
is passed as an argument to an SQL statement, the JDBC driver calls the methodSQLData.getSQLType
to determine the kind of SQL datum being passed to the database. The driver then creates an instance ofSQLOutput
and passes it to the methodSQLData.writeSQL
. The methodwriteSQL
in turn calls the appropriateSQLOutput
writer methodswriteBoolean
,writeCharacterStream
, and so on) to write data from theSQLData
object to theSQLOutput
output stream as the representation of an SQL user-defined type.- Since:
- 1.2
-
-
Method Summary
Methods Modifier and Type Method and Description void
writeArray(Array x)
Writes an SQLARRAY
value to the stream.void
writeAsciiStream(InputStream x)
Writes the next attribute to the stream as a stream of ASCII characters.void
writeBigDecimal(BigDecimal x)
Writes the next attribute to the stream as a java.math.BigDecimal object.void
writeBinaryStream(InputStream x)
Writes the next attribute to the stream as a stream of uninterpreted bytes.void
writeBlob(Blob x)
Writes an SQLBLOB
value to the stream.void
writeBoolean(boolean x)
Writes the next attribute to the stream as a Java boolean.void
writeByte(byte x)
Writes the next attribute to the stream as a Java byte.void
writeBytes(byte[] x)
Writes the next attribute to the stream as an array of bytes.void
writeCharacterStream(Reader x)
Writes the next attribute to the stream as a stream of Unicode characters.void
writeClob(Clob x)
Writes an SQLCLOB
value to the stream.void
writeDate(Date x)
Writes the next attribute to the stream as a java.sql.Date object.void
writeDouble(double x)
Writes the next attribute to the stream as a Java double.void
writeFloat(float x)
Writes the next attribute to the stream as a Java float.void
writeInt(int x)
Writes the next attribute to the stream as a Java int.void
writeLong(long x)
Writes the next attribute to the stream as a Java long.void
writeNClob(NClob x)
Writes an SQLNCLOB
value to the stream.void
writeNString(String x)
Writes the next attribute to the stream as aString
in the Java programming language.void
writeObject(SQLData x)
Writes to the stream the data contained in the givenSQLData
object.void
writeRef(Ref x)
Writes an SQLREF
value to the stream.void
writeRowId(RowId x)
Writes an SQLROWID
value to the stream.void
writeShort(short x)
Writes the next attribute to the stream as a Java short.void
writeSQLXML(SQLXML x)
Writes an SQLXML
value to the stream.void
writeString(String x)
Writes the next attribute to the stream as aString
in the Java programming language.void
writeStruct(Struct x)
Writes an SQL structured type value to the stream.void
writeTime(Time x)
Writes the next attribute to the stream as a java.sql.Time object.void
writeTimestamp(Timestamp x)
Writes the next attribute to the stream as a java.sql.Timestamp object.void
writeURL(URL x)
Writes a SQLDATALINK
value to the stream.
-
-
-
Method Detail
-
writeString
void writeString(String x) throws SQLException
Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeBoolean
void writeBoolean(boolean x) throws SQLException
Writes the next attribute to the stream as a Java boolean. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeByte
void writeByte(byte x) throws SQLException
Writes the next attribute to the stream as a Java byte. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeShort
void writeShort(short x) throws SQLException
Writes the next attribute to the stream as a Java short. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeInt
void writeInt(int x) throws SQLException
Writes the next attribute to the stream as a Java int. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeLong
void writeLong(long x) throws SQLException
Writes the next attribute to the stream as a Java long. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeFloat
void writeFloat(float x) throws SQLException
Writes the next attribute to the stream as a Java float. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeDouble
void writeDouble(double x) throws SQLException
Writes the next attribute to the stream as a Java double. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeBigDecimal
void writeBigDecimal(BigDecimal x) throws SQLException
Writes the next attribute to the stream as a java.math.BigDecimal object. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeBytes
void writeBytes(byte[] x) throws SQLException
Writes the next attribute to the stream as an array of bytes. Writes the next attribute to the stream as aString
in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeDate
void writeDate(Date x) throws SQLException
Writes the next attribute to the stream as a java.sql.Date object. Writes the next attribute to the stream as ajava.sql.Date
object in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeTime
void writeTime(Time x) throws SQLException
Writes the next attribute to the stream as a java.sql.Time object. Writes the next attribute to the stream as ajava.sql.Date
object in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeTimestamp
void writeTimestamp(Timestamp x) throws SQLException
Writes the next attribute to the stream as a java.sql.Timestamp object. Writes the next attribute to the stream as ajava.sql.Date
object in the Java programming language.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeCharacterStream
void writeCharacterStream(Reader x) throws SQLException
Writes the next attribute to the stream as a stream of Unicode characters.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeAsciiStream
void writeAsciiStream(InputStream x) throws SQLException
Writes the next attribute to the stream as a stream of ASCII characters.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeBinaryStream
void writeBinaryStream(InputStream x) throws SQLException
Writes the next attribute to the stream as a stream of uninterpreted bytes.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeObject
void writeObject(SQLData x) throws SQLException
Writes to the stream the data contained in the givenSQLData
object. When theSQLData
object isnull
, this method writes an SQLNULL
to the stream. Otherwise, it calls theSQLData.writeSQL
method of the given object, which writes the object's attributes to the stream. The implementation of the methodSQLData.writeSQ
calls the appropriateSQLOutput
writer method(s) for writing each of the object's attributes in order. The attributes must be read from anSQLInput
input stream and written to anSQLOutput
output stream in the same order in which they were listed in the SQL definition of the user-defined type.- Parameters:
x
- the object representing data of an SQL structured or distinct type- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeRef
void writeRef(Ref x) throws SQLException
Writes an SQLREF
value to the stream.- Parameters:
x
- aRef
object representing data of an SQLREF
value- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeBlob
void writeBlob(Blob x) throws SQLException
Writes an SQLBLOB
value to the stream.- Parameters:
x
- aBlob
object representing data of an SQLBLOB
value- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeClob
void writeClob(Clob x) throws SQLException
Writes an SQLCLOB
value to the stream.- Parameters:
x
- aClob
object representing data of an SQLCLOB
value- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeStruct
void writeStruct(Struct x) throws SQLException
Writes an SQL structured type value to the stream.- Parameters:
x
- aStruct
object representing data of an SQL structured type- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeArray
void writeArray(Array x) throws SQLException
Writes an SQLARRAY
value to the stream.- Parameters:
x
- anArray
object representing data of an SQLARRAY
type- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
writeURL
void writeURL(URL x) throws SQLException
Writes a SQLDATALINK
value to the stream.- Parameters:
x
- ajava.net.URL
object representing the data of SQL DATALINK type- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
writeNString
void writeNString(String x) throws SQLException
Writes the next attribute to the stream as aString
in the Java programming language. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
value (depending on the argument's size relative to the driver's limits onNVARCHAR
values) when it sends it to the stream.- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
writeNClob
void writeNClob(NClob x) throws SQLException
Writes an SQLNCLOB
value to the stream.- Parameters:
x
- aNClob
object representing data of an SQLNCLOB
value- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
writeRowId
void writeRowId(RowId x) throws SQLException
Writes an SQLROWID
value to the stream.- Parameters:
x
- aRowId
object representing data of an SQLROWID
value- Throws:
SQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
writeSQLXML
void writeSQLXML(SQLXML x) throws SQLException
Writes an SQLXML
value to the stream.- Parameters:
x
- aSQLXML
object representing data of an SQLXML
value- Throws:
SQLException
- if a database access error occurs, thejava.xml.transform.Result
,Writer
orOutputStream
has not been closed for theSQLXML
object or if there is an error processing the XML value. ThegetCause
method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/sql/sqloutput.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.