Showing the changes to java/pkg/javax/sql/rowset/spi/XmlWriter.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,74 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. | |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 | + * | |
| 5 | + * This code is free software; you can redistribute it and/or modify it | |
| 6 | + * under the terms of the GNU General Public License version 2 only, as | |
| 7 | + * published by the Free Software Foundation. Oracle designates this | |
| 8 | + * particular file as subject to the "Classpath" exception as provided | |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. | |
| 10 | + * | |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 | + * accompanied this code). | |
| 16 | + * | |
| 17 | + * You should have received a copy of the GNU General Public License version | |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 | + * | |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 | + * or visit www.oracle.com if you need additional information or have any | |
| 23 | + * questions. | |
| 24 | + */ | |
| 25 | + | |
| 26 | +package javax.sql.rowset.spi; | |
| 27 | + | |
| 28 | +import java.sql.SQLException; | |
| 29 | +import java.io.Writer; | |
| 30 | + | |
| 31 | +import javax.sql.RowSetWriter; | |
| 32 | +import javax.sql.rowset.*; | |
| 33 | + | |
| 34 | +/** | |
| 35 | + * A specialized interface that facilitates an extension of the | |
| 36 | + * <code>SyncProvider</code> abstract class for XML orientated | |
| 37 | + * synchronization providers. | |
| 38 | + * <p> | |
| 39 | + * <code>SyncProvider</code> implementations that supply XML data writer | |
| 40 | + * capabilities such as output XML stream capabilities can implement this | |
| 41 | + * interface to provider standard <code>XmlWriter</code> objects to | |
| 42 | + * <code>WebRowSet</code> implementations. | |
| 43 | + * <P> | |
| 44 | + * Writing a <code>WebRowSet</code> object includes printing the | |
| 45 | + * rowset's data, metadata, and properties, all with the | |
| 46 | + * appropriate XML tags. | |
| 47 | + */ | |
| 48 | +public interface XmlWriter extends RowSetWriter { | |
| 49 | + | |
| 50 | + /** | |
| 51 | + * Writes the given <code>WebRowSet</code> object to the specified | |
| 52 | + * <code>java.io.Writer</code> output stream as an XML document. | |
| 53 | + * This document includes the rowset's data, metadata, and properties | |
| 54 | + * plus the appropriate XML tags. | |
| 55 | + * <P> | |
| 56 | + * The <code>caller</code> parameter must be a <code>WebRowSet</code> | |
| 57 | + * object whose <code>XmlWriter</code> field contains a reference to | |
| 58 | + * this <code>XmlWriter</code> object. | |
| 59 | + * | |
| 60 | + * @param caller the <code>WebRowSet</code> instance to be written, | |
| 61 | + * for which this <code>XmlWriter</code> object is the writer | |
| 62 | + * @param writer the <code>java.io.Writer</code> object that serves | |
| 63 | + * as the output stream for writing <code>caller</code> as | |
| 64 | + * an XML document | |
| 65 | + * @throws SQLException if a database access error occurs or | |
| 66 | + * this <code>XmlWriter</code> object is not the writer | |
| 67 | + * for the given <code>WebRowSet</code> object | |
| 68 | + */ | |
| 69 | + public void writeXML(WebRowSet caller, java.io.Writer writer) | |
| 70 | + throws SQLException; | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | +} | |