Mercurial > jdk8-mips64-public > corba / annotate
src/share/classes/org/omg/CORBA/FixedHolder.java@52ad44f9a3ec (annotated)
src/share/classes/org/omg/CORBA/FixedHolder.java
Tue, 22 Oct 2013 11:40:27 +0100
- author
- alanb
- date
- Tue, 22 Oct 2013 11:40:27 +0100
- changeset 533
- 52ad44f9a3ec
- parent 158
- 91006f157c46
- child 748
- 6845b95cba6b
- permissions
- -rw-r--r--
8021257: com.sun.corba.se.** should be on restricted package list
Reviewed-by: chegar, coffeys, smarks
Contributed-by: alan.bateman@oralce.com, mark.sheppard@oracle.com
| duke@1 | 1 | /* |
| ohair@158 | 2 | * Copyright (c) 1998, 2001, 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 | |
| duke@1 | 26 | package org.omg.CORBA; |
| duke@1 | 27 | |
| duke@1 | 28 | import org.omg.CORBA.portable.Streamable; |
| duke@1 | 29 | import org.omg.CORBA.portable.InputStream; |
| duke@1 | 30 | import org.omg.CORBA.portable.OutputStream; |
| duke@1 | 31 | |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * The Holder for <tt>Fixed</tt>. For more information on |
| duke@1 | 35 | * Holder files, see <a href="doc-files/generatedfiles.html#holder"> |
| duke@1 | 36 | * "Generated Files: Holder Files"</a>.<P> |
| duke@1 | 37 | * FixedHolder is a container class for values of IDL type "fixed", |
| duke@1 | 38 | * which is mapped to the Java class java.math.BigDecimal. |
| duke@1 | 39 | * It is usually used to store "out" and "inout" IDL method parameters. |
| duke@1 | 40 | * If an IDL method signature has a fixed as an "out" or "inout" parameter, |
| duke@1 | 41 | * the programmer must pass an instance of FixedHolder as the corresponding |
| duke@1 | 42 | * parameter in the method invocation; for "inout" parameters, the programmer |
| duke@1 | 43 | * must also fill the "in" value to be sent to the server. |
| duke@1 | 44 | * Before the method invocation returns, the ORB will fill in the contained |
| duke@1 | 45 | * value corresponding to the "out" value returned from the server. |
| duke@1 | 46 | * |
| duke@1 | 47 | */ |
| duke@1 | 48 | public final class FixedHolder implements Streamable { |
| duke@1 | 49 | /** |
| duke@1 | 50 | * The value held by the FixedHolder |
| duke@1 | 51 | */ |
| duke@1 | 52 | public java.math.BigDecimal value; |
| duke@1 | 53 | |
| duke@1 | 54 | /** |
| duke@1 | 55 | * Construct the FixedHolder without initializing the contained value. |
| duke@1 | 56 | */ |
| duke@1 | 57 | public FixedHolder() { |
| duke@1 | 58 | } |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Construct the FixedHolder and initialize it with the given value. |
| duke@1 | 62 | * @param initial the value used to initialize the FixedHolder |
| duke@1 | 63 | */ |
| duke@1 | 64 | public FixedHolder(java.math.BigDecimal initial) { |
| duke@1 | 65 | value = initial; |
| duke@1 | 66 | } |
| duke@1 | 67 | |
| duke@1 | 68 | /** |
| duke@1 | 69 | * Read a fixed point value from the input stream and store it in |
| duke@1 | 70 | * the value member. |
| duke@1 | 71 | * |
| duke@1 | 72 | * @param input the <code>InputStream</code> to read from. |
| duke@1 | 73 | */ |
| duke@1 | 74 | public void _read(InputStream input) { |
| duke@1 | 75 | value = input.read_fixed(); |
| duke@1 | 76 | } |
| duke@1 | 77 | |
| duke@1 | 78 | /** |
| duke@1 | 79 | * Write the fixed point value stored in this holder to an |
| duke@1 | 80 | * <code>OutputStream</code>. |
| duke@1 | 81 | * |
| duke@1 | 82 | * @param output the <code>OutputStream</code> to write into. |
| duke@1 | 83 | */ |
| duke@1 | 84 | public void _write(OutputStream output) { |
| duke@1 | 85 | output.write_fixed(value); |
| duke@1 | 86 | } |
| duke@1 | 87 | |
| duke@1 | 88 | |
| duke@1 | 89 | /** |
| duke@1 | 90 | * Return the <code>TypeCode</code> of this holder object. |
| duke@1 | 91 | * |
| duke@1 | 92 | * @return the <code>TypeCode</code> object. |
| duke@1 | 93 | */ |
| duke@1 | 94 | public org.omg.CORBA.TypeCode _type() { |
| duke@1 | 95 | return ORB.init().get_primitive_tc(TCKind.tk_fixed); |
| duke@1 | 96 | } |
| duke@1 | 97 | |
| duke@1 | 98 | } |
