Streamable.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 1997, 1999, 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 */
25package org.omg.CORBA.portable;
26
27import org.omg.CORBA.TypeCode;
28
29/**
30 * The base class for the Holder classess of all complex
31 * IDL types. The ORB treats all generated Holders as Streamable to invoke
32 * the methods for marshalling and unmarshalling.
33 *
34 * @since   JDK1.2
35 */
36
37public interface Streamable {
38    /**
39     * Reads data from <code>istream</code> and initalizes the
40     * <code>value</code> field of the Holder with the unmarshalled data.
41     *
42     * @param     istream   the InputStream that represents the CDR data from the wire.
43     */
44    void _read(InputStream istream);
45    /**
46     * Marshals to <code>ostream</code> the value in the
47     * <code>value</code> field of the Holder.
48     *
49     * @param     ostream   the CDR OutputStream
50     */
51    void _write(OutputStream ostream);
52
53    /**
54     * Retrieves the <code>TypeCode</code> object corresponding to the value
55     * in the <code>value</code> field of the Holder.
56     *
57     * @return    the <code>TypeCode</code> object for the value held in the holder
58     */
59    TypeCode _type();
60}
61