src/java.sql/share/classes/java/sql/SQLXML.java
author alanb
Tue, 15 May 2018 09:33:02 +0100
changeset 50109 ea54197f4fe4
parent 47216 71c04702a3d5
permissions -rw-r--r--
8203059: (so) Closing a socket channel registered with Selector and with SO_LINGER set to 0 does not reset connection Reviewed-by: chegar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
     2
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.sql;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.io.InputStream;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.io.OutputStream;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.io.Reader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.io.Writer;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
import javax.xml.transform.Result;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
import javax.xml.transform.Source;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * The mapping in the JavaTM programming language for the SQL XML type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * XML is a built-in type that stores an XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * as a column value in a row of a database table.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * By default drivers implement an SQLXML object as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * a logical pointer to the XML data
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * rather than the data itself.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * An SQLXML object is valid for the duration of the transaction in which it was created.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * The SQLXML interface provides methods for accessing the XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * as a String, a Reader or Writer, or as a Stream.  The XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * may also be accessed through a Source or set as a Result, which
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * are used with XML Parser APIs such as DOM, SAX, and StAX, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * well as with XSLT transforms and XPath evaluations.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * such as getSQLXML allow a programmer to access an XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * In addition, this interface has methods for updating an XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * The XML value of the SQLXML instance may be obtained as a BinaryStream using
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 *   SQLXML sqlxml = resultSet.getSQLXML(column);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 *   InputStream binaryStream = sqlxml.getBinaryStream();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 * For example, to parse an XML value with a DOM parser:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 *   DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 *   Document result = parser.parse(binaryStream);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * or to parse an XML value with a SAX parser to your handler:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 *   SAXParser parser = SAXParserFactory.newInstance().newSAXParser();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 *   parser.parse(binaryStream, myHandler);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
 * or to parse an XML value with a StAX parser:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
 *   XMLInputFactory factory = XMLInputFactory.newInstance();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
 *   XMLStreamReader streamReader = factory.createXMLStreamReader(binaryStream);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
 * Because databases may use an optimized representation for the XML,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
 * accessing the value through getSource() and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
 * setResult() can lead to improved processing performance
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
 * without serializing to a stream representation and parsing the XML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
 * For example, to obtain a DOM Document Node:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
 *   DOMSource domSource = sqlxml.getSource(DOMSource.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
 *   Document document = (Document) domSource.getNode();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
 * or to set the value to a DOM Document Node to myNode:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
 *   DOMResult domResult = sqlxml.setResult(DOMResult.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
 *   domResult.setNode(myNode);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
 * or, to send SAX events to your handler:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
 *   SAXSource saxSource = sqlxml.getSource(SAXSource.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
 *   XMLReader xmlReader = saxSource.getXMLReader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
 *   xmlReader.setContentHandler(myHandler);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
 *   xmlReader.parse(saxSource.getInputSource());
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
 * or, to set the result value from SAX events:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
 *   SAXResult saxResult = sqlxml.setResult(SAXResult.class);
19389
044bdfe2b361 8022753: SQLXML javadoc example typo
lancea
parents: 18564
diff changeset
   101
 *   ContentHandler contentHandler = saxResult.getHandler();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
 *   contentHandler.startDocument();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
 *   // set the XML elements and attributes into the result
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
 *   contentHandler.endDocument();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
 * or, to obtain StAX events:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
 *   StAXSource staxSource = sqlxml.getSource(StAXSource.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
 *   XMLStreamReader streamReader = staxSource.getXMLStreamReader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
 * or, to set the result value from StAX events:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
 *   StAXResult staxResult = sqlxml.setResult(StAXResult.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
 *   XMLStreamWriter streamWriter = staxResult.getXMLStreamWriter();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
 * or, to perform XSLT transformations on the XML value using the XSLT in xsltFile
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
 * output to file resultFile:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
 *   File xsltFile = new File("a.xslt");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
 *   File myFile = new File("result.xml");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
 *   Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
 *   Source source = sqlxml.getSource(null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
 *   Result result = new StreamResult(myFile);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
 *   xslt.transform(source, result);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
 * or, to evaluate an XPath expression on the XML value:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
 *   XPath xpath = XPathFactory.newInstance().newXPath();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
 *   DOMSource domSource = sqlxml.getSource(DOMSource.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
 *   Document document = (Document) domSource.getNode();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
 *   String expression = "/foo/@bar";
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
 *   String barValue = xpath.evaluate(expression, document);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
 * To set the XML value to be the result of an XSLT transform:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
 *   File sourceFile = new File("source.xml");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
 *   Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
 *   Source streamSource = new StreamSource(sourceFile);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
 *   Result result = sqlxml.setResult(null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
 *   xslt.transform(streamSource, result);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
 * Any Source can be transformed to a Result using the identity transform
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
 * specified by calling newTransformer():
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
 *   Transformer identity = TransformerFactory.newInstance().newTransformer();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
 *   Source source = sqlxml.getSource(null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
 *   File myFile = new File("result.xml");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
 *   Result result = new StreamResult(myFile);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
 *   identity.transform(source, result);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
 * To write the contents of a Source to standard output:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
 *   Transformer identity = TransformerFactory.newInstance().newTransformer();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
 *   Source source = sqlxml.getSource(null);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
 *   Result result = new StreamResult(System.out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
 *   identity.transform(source, result);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
 * To create a DOMSource from a DOMResult:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
 *    DOMSource domSource = new DOMSource(domResult.getNode());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
 * Incomplete or invalid XML values may cause an SQLException when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
 * set or the exception may occur when execute() occurs.  All streams
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
 * must be closed before execute() occurs or an SQLException will be thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
 * Reading and writing XML values to or from an SQLXML object can happen at most once.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
 * The conceptual states of readable and not readable determine if one
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
 * of the reading APIs will return a value or throw an exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
 * The conceptual states of writable and not writable determine if one
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
 * of the writing APIs will set a value or throw an exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
 * The state moves from readable to not readable once free() or any of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
 * reading APIs are called: getBinaryStream(), getCharacterStream(), getSource(), and getString().
90ce3da70b43 Initial load
duke
parents:
diff changeset
   175
 * Implementations may also change the state to not writable when this occurs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
 * <p>
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   177
 * The state moves from writable to not writable once free() or any of the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   178
 * writing APIs are called: setBinaryStream(), setCharacterStream(), setResult(), and setString().
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
 * Implementations may also change the state to not readable when this occurs.
20880
1b610151b316 8026812: doclint clean up for java.sql and javax.sql
lancea
parents: 19389
diff changeset
   180
 *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   182
 * All methods on the <code>SQLXML</code> interface must be fully implemented if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
 * JDBC driver supports the data type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
 * @see javax.xml.parsers
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
 * @see javax.xml.stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
 * @see javax.xml.transform
90ce3da70b43 Initial load
duke
parents:
diff changeset
   188
 * @see javax.xml.xpath
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
 * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
public interface SQLXML
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
{
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
   * This method closes this object and releases the resources that it held.
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   195
   * The SQL XML object becomes invalid and neither readable or writable
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
   * when this method is called.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   198
   * After <code>free</code> has been called, any attempt to invoke a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   199
   * method other than <code>free</code> will result in a <code>SQLException</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   200
   * being thrown.  If <code>free</code> is called multiple times, the subsequent
90ce3da70b43 Initial load
duke
parents:
diff changeset
   201
   * calls to <code>free</code> are treated as a no-op.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   202
   * @throws SQLException if there is an error freeing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   203
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   204
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   205
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   206
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   207
  void free() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   208
90ce3da70b43 Initial load
duke
parents:
diff changeset
   209
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   210
   * Retrieves the XML value designated by this SQLXML instance as a stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   211
   * The bytes of the input stream are interpreted according to appendix F of the XML 1.0 specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   212
   * The behavior of this method is the same as ResultSet.getBinaryStream()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   213
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   214
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   215
   * The SQL XML object becomes not readable when this method is called and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   216
   * may also become not writable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   217
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   218
   * @return a stream containing the XML data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   219
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   220
   *   An exception is thrown if the state is not readable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   221
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   222
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   223
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   224
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   225
  InputStream getBinaryStream() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   226
90ce3da70b43 Initial load
duke
parents:
diff changeset
   227
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   228
   * Retrieves a stream that can be used to write the XML value that this SQLXML instance represents.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   229
   * The stream begins at position 0.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   230
   * The bytes of the stream are interpreted according to appendix F of the XML 1.0 specification
90ce3da70b43 Initial load
duke
parents:
diff changeset
   231
   * The behavior of this method is the same as ResultSet.updateBinaryStream()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   232
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   233
   * <p>
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   234
   * The SQL XML object becomes not writable when this method is called and
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   235
   * may also become not readable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   236
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   237
   * @return a stream to which data can be written.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   238
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   239
   *   An exception is thrown if the state is not writable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   240
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   241
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   242
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   243
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   244
  OutputStream setBinaryStream() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   245
90ce3da70b43 Initial load
duke
parents:
diff changeset
   246
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   247
   * Retrieves the XML value designated by this SQLXML instance as a java.io.Reader object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   248
   * The format of this stream is defined by org.xml.sax.InputSource,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   249
   * where the characters in the stream represent the unicode code points for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   250
   * XML according to section 2 and appendix B of the XML 1.0 specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   251
   * Although an encoding declaration other than unicode may be present,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   252
   * the encoding of the stream is unicode.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   253
   * The behavior of this method is the same as ResultSet.getCharacterStream()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   254
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   255
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   256
   * The SQL XML object becomes not readable when this method is called and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   257
   * may also become not writable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   258
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   259
   * @return a stream containing the XML data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   260
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   261
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   262
   *   if the stream does not contain valid characters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   263
   *   An exception is thrown if the state is not readable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   264
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   265
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   266
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   267
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   268
  Reader getCharacterStream() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   269
90ce3da70b43 Initial load
duke
parents:
diff changeset
   270
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   271
   * Retrieves a stream to be used to write the XML value that this SQLXML instance represents.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   272
   * The format of this stream is defined by org.xml.sax.InputSource,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   273
   * where the characters in the stream represent the unicode code points for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   274
   * XML according to section 2 and appendix B of the XML 1.0 specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   275
   * Although an encoding declaration other than unicode may be present,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   276
   * the encoding of the stream is unicode.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   277
   * The behavior of this method is the same as ResultSet.updateCharacterStream()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   278
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   279
   * <p>
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   280
   * The SQL XML object becomes not writable when this method is called and
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   281
   * may also become not readable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   282
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   283
   * @return a stream to which data can be written.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   284
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   285
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   286
   *   if the stream does not contain valid characters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   287
   *   An exception is thrown if the state is not writable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   288
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   289
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   290
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   291
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   292
  Writer setCharacterStream() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   293
90ce3da70b43 Initial load
duke
parents:
diff changeset
   294
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   295
   * Returns a string representation of the XML value designated by this SQLXML instance.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   296
   * The format of this String is defined by org.xml.sax.InputSource,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   297
   * where the characters in the stream represent the unicode code points for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   298
   * XML according to section 2 and appendix B of the XML 1.0 specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   299
   * Although an encoding declaration other than unicode may be present,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   300
   * the encoding of the String is unicode.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   301
   * The behavior of this method is the same as ResultSet.getString()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   302
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   303
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   304
   * The SQL XML object becomes not readable when this method is called and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   305
   * may also become not writable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   306
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   307
   * @return a string representation of the XML value designated by this SQLXML instance.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   308
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   309
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   310
   *   if the stream does not contain valid characters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   311
   *   An exception is thrown if the state is not readable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   312
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   313
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   314
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   315
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   316
  String getString() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   317
90ce3da70b43 Initial load
duke
parents:
diff changeset
   318
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   319
   * Sets the XML value designated by this SQLXML instance to the given String representation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   320
   * The format of this String is defined by org.xml.sax.InputSource,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   321
   * where the characters in the stream represent the unicode code points for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   322
   * XML according to section 2 and appendix B of the XML 1.0 specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   323
   * Although an encoding declaration other than unicode may be present,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   324
   * the encoding of the String is unicode.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   325
   * The behavior of this method is the same as ResultSet.updateString()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   326
   * when the designated column of the ResultSet has a type java.sql.Types of SQLXML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   327
   * <p>
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   328
   * The SQL XML object becomes not writable when this method is called and
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   329
   * may also become not readable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   330
   *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   331
   * @param value the XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   332
   * @throws SQLException if there is an error processing the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   333
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   334
   *   if the stream does not contain valid characters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   335
   *   An exception is thrown if the state is not writable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   336
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   337
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   338
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   339
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   340
  void setString(String value) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   341
90ce3da70b43 Initial load
duke
parents:
diff changeset
   342
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   343
   * Returns a Source for reading the XML value designated by this SQLXML instance.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   344
   * Sources are used as inputs to XML parsers and XSLT transformers.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   345
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   346
   * Sources for XML parsers will have namespace processing on by default.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   347
   * The systemID of the Source is implementation dependent.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   348
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   349
   * The SQL XML object becomes not readable when this method is called and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   350
   * may also become not writable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   351
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   352
   * Note that SAX is a callback architecture, so a returned
90ce3da70b43 Initial load
duke
parents:
diff changeset
   353
   * SAXSource should then be set with a content handler that will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   354
   * receive the SAX events from parsing.  The content handler
90ce3da70b43 Initial load
duke
parents:
diff changeset
   355
   * will receive callbacks based on the contents of the XML.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   356
   * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   357
   *   SAXSource saxSource = sqlxml.getSource(SAXSource.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   358
   *   XMLReader xmlReader = saxSource.getXMLReader();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   359
   *   xmlReader.setContentHandler(myHandler);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   360
   *   xmlReader.parse(saxSource.getInputSource());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   361
   * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   362
   *
18564
f9db68ff2cbb 8017471: Fix JDBC -Xdoclint public errors
lancea
parents: 5506
diff changeset
   363
   * @param <T> the type of the class modeled by this Class object
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   364
   * @param sourceClass The class of the source, or null.
21278
ef8a3a2a72f2 8022746: List of spelling errors in API doc
malenkov
parents: 20880
diff changeset
   365
   * If the class is null, a vendor specific Source implementation will be returned.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   366
   * The following classes are supported at a minimum:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   367
   * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   368
   *   javax.xml.transform.dom.DOMSource - returns a DOMSource
90ce3da70b43 Initial load
duke
parents:
diff changeset
   369
   *   javax.xml.transform.sax.SAXSource - returns a SAXSource
90ce3da70b43 Initial load
duke
parents:
diff changeset
   370
   *   javax.xml.transform.stax.StAXSource - returns a StAXSource
90ce3da70b43 Initial load
duke
parents:
diff changeset
   371
   *   javax.xml.transform.stream.StreamSource - returns a StreamSource
90ce3da70b43 Initial load
duke
parents:
diff changeset
   372
   * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   373
   * @return a Source for reading the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   374
   * @throws SQLException if there is an error processing the XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   375
   *   or if this feature is not supported.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   376
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   377
   *   if an XML parser exception occurs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   378
   *   An exception is thrown if the state is not readable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   379
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   380
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   381
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   382
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   383
  <T extends Source> T getSource(Class<T> sourceClass) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   384
90ce3da70b43 Initial load
duke
parents:
diff changeset
   385
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   386
   * Returns a Result for setting the XML value designated by this SQLXML instance.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   387
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   388
   * The systemID of the Result is implementation dependent.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   389
   * <p>
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 21278
diff changeset
   390
   * The SQL XML object becomes not writable when this method is called and
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   391
   * may also become not readable depending on implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   392
   * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   393
   * Note that SAX is a callback architecture and the returned
90ce3da70b43 Initial load
duke
parents:
diff changeset
   394
   * SAXResult has a content handler assigned that will receive the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   395
   * SAX events based on the contents of the XML.  Call the content
90ce3da70b43 Initial load
duke
parents:
diff changeset
   396
   * handler with the contents of the XML document to assign the values.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   397
   * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   398
   *   SAXResult saxResult = sqlxml.setResult(SAXResult.class);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   399
   *   ContentHandler contentHandler = saxResult.getXMLReader().getContentHandler();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   400
   *   contentHandler.startDocument();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   401
   *   // set the XML elements and attributes into the result
90ce3da70b43 Initial load
duke
parents:
diff changeset
   402
   *   contentHandler.endDocument();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   403
   * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   404
   *
18564
f9db68ff2cbb 8017471: Fix JDBC -Xdoclint public errors
lancea
parents: 5506
diff changeset
   405
   * @param <T> the type of the class modeled by this Class object
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   406
   * @param resultClass The class of the result, or null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   407
   * If resultClass is null, a vendor specific Result implementation will be returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   408
   * The following classes are supported at a minimum:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   409
   * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   410
   *   javax.xml.transform.dom.DOMResult - returns a DOMResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
   411
   *   javax.xml.transform.sax.SAXResult - returns a SAXResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
   412
   *   javax.xml.transform.stax.StAXResult - returns a StAXResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
   413
   *   javax.xml.transform.stream.StreamResult - returns a StreamResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
   414
   * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   415
   * @return Returns a Result for setting the XML value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   416
   * @throws SQLException if there is an error processing the XML value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   417
   *   or if this feature is not supported.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   418
   *   The getCause() method of the exception may provide a more detailed exception, for example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   419
   *   if an XML parser exception occurs.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   420
   *   An exception is thrown if the state is not writable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   421
   * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   422
   * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   423
   * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   424
   */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   425
  <T extends Result> T setResult(Class<T> resultClass) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   426
90ce3da70b43 Initial load
duke
parents:
diff changeset
   427
}