corba/src/share/classes/org/omg/CORBA/CustomMarshal.java
author ohair
Tue, 25 May 2010 15:52:11 -0700
changeset 5555 b2b5ed3f0d0d
parent 4 02bb8761fcce
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     1
/*
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     2
 * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
02bb8761fcce Initial load
duke
parents:
diff changeset
     4
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
02bb8761fcce Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    10
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
02bb8761fcce Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
02bb8761fcce Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
02bb8761fcce Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
02bb8761fcce Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
02bb8761fcce Initial load
duke
parents:
diff changeset
    16
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
02bb8761fcce Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
02bb8761fcce Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
02bb8761fcce Initial load
duke
parents:
diff changeset
    20
 *
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    23
 * questions.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    24
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    25
02bb8761fcce Initial load
duke
parents:
diff changeset
    26
package org.omg.CORBA;
02bb8761fcce Initial load
duke
parents:
diff changeset
    27
02bb8761fcce Initial load
duke
parents:
diff changeset
    28
import org.omg.CORBA.DataOutputStream;
02bb8761fcce Initial load
duke
parents:
diff changeset
    29
import org.omg.CORBA.DataInputStream;
02bb8761fcce Initial load
duke
parents:
diff changeset
    30
02bb8761fcce Initial load
duke
parents:
diff changeset
    31
/**
02bb8761fcce Initial load
duke
parents:
diff changeset
    32
 * An abstract value type that is meant to
02bb8761fcce Initial load
duke
parents:
diff changeset
    33
 * be used by the ORB, not the user. Semantically it is treated
02bb8761fcce Initial load
duke
parents:
diff changeset
    34
 * as a custom value type's implicit base class, although the custom
02bb8761fcce Initial load
duke
parents:
diff changeset
    35
 * valuetype does not actually inherit it in IDL. The implementer
02bb8761fcce Initial load
duke
parents:
diff changeset
    36
 * of a custom value type shall provide an implementation of the
02bb8761fcce Initial load
duke
parents:
diff changeset
    37
 * <tt>CustomMarshal</tt> operations. The manner in which this is done is
02bb8761fcce Initial load
duke
parents:
diff changeset
    38
 * specified in the IDL to Java langauge mapping. Each custom
02bb8761fcce Initial load
duke
parents:
diff changeset
    39
 * marshaled value type shall have its own implementation.
02bb8761fcce Initial load
duke
parents:
diff changeset
    40
 * @see DataInputStream
02bb8761fcce Initial load
duke
parents:
diff changeset
    41
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    42
public interface CustomMarshal {
02bb8761fcce Initial load
duke
parents:
diff changeset
    43
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    44
     * Marshal method has to be implemented by the Customized Marshal class.
02bb8761fcce Initial load
duke
parents:
diff changeset
    45
     * This is the method invoked for Marshalling.
02bb8761fcce Initial load
duke
parents:
diff changeset
    46
     *
02bb8761fcce Initial load
duke
parents:
diff changeset
    47
     * @param os a DataOutputStream
02bb8761fcce Initial load
duke
parents:
diff changeset
    48
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    49
    void marshal(DataOutputStream os);
02bb8761fcce Initial load
duke
parents:
diff changeset
    50
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    51
     * Unmarshal method has to be implemented by the Customized Marshal class.
02bb8761fcce Initial load
duke
parents:
diff changeset
    52
     * This is the method invoked for Unmarshalling.
02bb8761fcce Initial load
duke
parents:
diff changeset
    53
     *
02bb8761fcce Initial load
duke
parents:
diff changeset
    54
     * @param is a DataInputStream
02bb8761fcce Initial load
duke
parents:
diff changeset
    55
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    56
    void unmarshal(DataInputStream is);
02bb8761fcce Initial load
duke
parents:
diff changeset
    57
}