CustomMarshal.java revision 704:3ef63dbde965
1/*
2 * Copyright (c) 1999, 2003, 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 */
25
26package org.omg.CORBA;
27
28import org.omg.CORBA.DataOutputStream;
29import org.omg.CORBA.DataInputStream;
30
31/**
32 * An abstract value type that is meant to
33 * be used by the ORB, not the user. Semantically it is treated
34 * as a custom value type's implicit base class, although the custom
35 * valuetype does not actually inherit it in IDL. The implementer
36 * of a custom value type shall provide an implementation of the
37 * {@code CustomMarshal} operations. The manner in which this is done is
38 * specified in the IDL to Java langauge mapping. Each custom
39 * marshaled value type shall have its own implementation.
40 * @see DataInputStream
41 */
42public interface CustomMarshal {
43    /**
44     * Marshal method has to be implemented by the Customized Marshal class.
45     * This is the method invoked for Marshalling.
46     *
47     * @param os a DataOutputStream
48     */
49    void marshal(DataOutputStream os);
50    /**
51     * Unmarshal method has to be implemented by the Customized Marshal class.
52     * This is the method invoked for Unmarshalling.
53     *
54     * @param is a DataInputStream
55     */
56    void unmarshal(DataInputStream is);
57}
58