diff options
Diffstat (limited to 'tags/java-M1-final/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/XMLStreamHelper.java')
-rw-r--r-- | tags/java-M1-final/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/XMLStreamHelper.java | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/tags/java-M1-final/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/XMLStreamHelper.java b/tags/java-M1-final/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/XMLStreamHelper.java deleted file mode 100644 index 4375faa9f3..0000000000 --- a/tags/java-M1-final/java/sdo/impl/src/main/java/org/apache/tuscany/sdo/XMLStreamHelper.java +++ /dev/null @@ -1,89 +0,0 @@ -/** - * - * Copyright 2006 The Apache Software Foundation - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.tuscany.sdo; - -import javax.xml.stream.XMLStreamException; -import javax.xml.stream.XMLStreamReader; -import javax.xml.stream.XMLStreamWriter; - -import commonj.sdo.DataObject; -import commonj.sdo.helper.XMLDocument; - -/** - * Helper interface for reading and writing SDO DataObjects from XML streams. - * - * @version $Rev$ $Date$ - */ -public interface XMLStreamHelper { - /** - * Creates and returns an XMLDocument from an XML input stream. - * The reader must be positioned on a START_DOCUMENT event. - * - * @param reader the stream to read - * @return an XMLDocument created from the stream - * @throws XMLStreamException if there was a problem reading the stream - * @throws IllegalStateException if the reader is not positioned on a START_DOCUMENT event - */ - XMLDocument load(XMLStreamReader reader) throws XMLStreamException, IllegalStateException; - - /** - * Save a XMLDocument to an XML stream. - * - * @param document the document to be written - * @param writer the stream to write to - * @throws XMLStreamException if there was a problem writing to the stream - */ - void save(XMLDocument document, XMLStreamWriter writer) throws XMLStreamException; - - /** - * Creates and returns a XMLStreamReader that can be used to read an XMLDocument as a XML event stream. - * The reader will be positioned on a START_DOCUMENT event. - * - * @param document the XMLDocument to be read - * @return an XMLStreamReader that can be used to read the document - */ - XMLStreamReader createXMLStreamReader(XMLDocument document) throws XMLStreamException; - - /** - * Create a DataObject from an element in a XML stream. - * The reader must be positioned on a START_ELEMENT event. - * - * @param reader the stream to read - * @return a DataObject created from the element in the stream - * @throws XMLStreamException if there was a problem reading the stream - * @throws IllegalStateException if the reader is not positioned on a START_ELEMENT event - */ - DataObject loadObject(XMLStreamReader reader) throws XMLStreamException, IllegalStateException; - - /** - * Save a DataObject to an XML stream. - * - * @param sdo the DataObject to be written - * @param writer the stream to write to - * @throws XMLStreamException if there was a problem writing to the stream - */ - void saveObject(DataObject sdo, XMLStreamWriter writer) throws XMLStreamException; - - /** - * Creates and returns a XMLStreamReader that can be used to read a DataObject as a XML event stream. - * The reader will be positioned on a START_ELEMENT event. - * - * @param sdo the DataObject to be read - * @return an XMLStreamReader that can be used to read the DataObject - */ - XMLStreamReader createXMLStreamReader(DataObject sdo); -} |