javax.resource.cci.Streamable Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.resource.cci;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.IOException;
/** Streamable interface enables a resource adapter to extract data from
* an input Record or set data into an output Record as a stream of
* bytes.
*
* The Streamable interface provides a resource adapter's view
* of the data that has been set in a Record instance by a component.
*
*
The Streamable interface is not directly used by a component. It
* is used by a resource adapter implementation. A component uses Record
* or any derived interfaces to manage records.
*
* @author Rahul Sharma
* @since 0.8
* @see javax.resource.cci.Record
**/
public interface Streamable {
/** Read data from an InputStream and initialize fields of a
* Streamable object.
*
* @param istream InputStream that represents a resource
* adapter specific internal representation
* of fields of a Streamable object
**/
public
void read(InputStream istream) throws IOException;
/** Write fields of a Streamable object to an OutputStream
* @param ostream OutputStream that holds value of a
* Streamable object
**/
public
void write(OutputStream ostream) throws IOException;
}