src/share/classes/org/omg/CORBA/portable/Streamable.java

Mon, 14 Jun 2010 11:28:53 -0700

author
jjg
date
Mon, 14 Jun 2010 11:28:53 -0700
changeset 173
032585ad970d
parent 158
91006f157c46
child 748
6845b95cba6b
permissions
-rw-r--r--

6960831: fix CORBA build warnings
Reviewed-by: darcy

duke@1 1 /*
ohair@158 2 * Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@158 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@158 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@158 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@158 22 * or visit www.oracle.com if you need additional information or have any
ohair@158 23 * questions.
duke@1 24 */
duke@1 25 package org.omg.CORBA.portable;
duke@1 26
duke@1 27 import org.omg.CORBA.TypeCode;
duke@1 28
duke@1 29 /**
duke@1 30 * The base class for the Holder classess of all complex
duke@1 31 * IDL types. The ORB treats all generated Holders as Streamable to invoke
duke@1 32 * the methods for marshalling and unmarshalling.
duke@1 33 *
duke@1 34 * @since JDK1.2
duke@1 35 */
duke@1 36
duke@1 37 public interface Streamable {
duke@1 38 /**
duke@1 39 * Reads data from <code>istream</code> and initalizes the
duke@1 40 * <code>value</code> field of the Holder with the unmarshalled data.
duke@1 41 *
duke@1 42 * @param istream the InputStream that represents the CDR data from the wire.
duke@1 43 */
duke@1 44 void _read(InputStream istream);
duke@1 45 /**
duke@1 46 * Marshals to <code>ostream</code> the value in the
duke@1 47 * <code>value</code> field of the Holder.
duke@1 48 *
duke@1 49 * @param ostream the CDR OutputStream
duke@1 50 */
duke@1 51 void _write(OutputStream ostream);
duke@1 52
duke@1 53 /**
duke@1 54 * Retrieves the <code>TypeCode</code> object corresponding to the value
duke@1 55 * in the <code>value</code> field of the Holder.
duke@1 56 *
duke@1 57 * @return the <code>TypeCode</code> object for the value held in the holder
duke@1 58 */
duke@1 59 TypeCode _type();
duke@1 60 }

mercurial