1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36 package javax.resource.cci;
37
38
39 import java.io.InputStream;
40 import java.io.OutputStream;
41 import java.io.IOException;
42
43 /** Streamable interface enables a resource adapter to extract data from
44 * an input Record or set data into an output Record as a stream of
45 * bytes.
46 *
47 * <p>The Streamable interface provides a resource adapter's view
48 * of the data that has been set in a Record instance by a component.
49 *
50 * <p>The Streamable interface is not directly used by a component. It
51 * is used by a resource adapter implementation. A component uses Record
52 * or any derived interfaces to manage records.
53 *
54 * @author Rahul Sharma
55 * @since 0.8
56 * @see javax.resource.cci.Record
57 **/
58
59 public interface Streamable {
60
61 /** Read data from an InputStream and initialize fields of a
62 * Streamable object.
63 *
64 * @param istream InputStream that represents a resource
65 * adapter specific internal representation
66 * of fields of a Streamable object
67 **/
68 public
69 void read(InputStream istream) throws IOException;
70
71
72 /** Write fields of a Streamable object to an OutputStream
73 * @param ostream OutputStream that holds value of a
74 * Streamable object
75 **/
76 public
77 void write(OutputStream ostream) throws IOException;
78
79 }
80
Save This Page