1 /* FixedHolder.java -- 2 Copyright (C) 2005, 2006 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package org.omg.CORBA; 40 41 import gnu.CORBA.typecodes.FixedTypeCode; 42 43 import java.math.BigDecimal; 44 45 import org.omg.CORBA.portable.InputStream; 46 import org.omg.CORBA.portable.OutputStream; 47 import org.omg.CORBA.portable.Streamable; 48 49 /** 50 * A holder for CORBA <code>fixed</code> that is mapped into 51 * java <code>BigDecimal</code>. 52 * 53 * The holders have several application areas. The end user usually 54 * sees them implementing CORBA methods where the primitive type 55 * is passed by reference. While CORBA (or, for example, C) supports 56 * this, the java does not and a wrapper class is required. 57 * 58 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 59 */ 60 public final class FixedHolder 61 implements Streamable 62 { 63 /** 64 * The <code>BigDecimal</code> (CORBA <code>fixed</code>) value, 65 * held by this FixedHolder. 66 */ 67 public BigDecimal value; 68 69 /** 70 * Constructs an instance of FixedHolder, 71 * initializing {@link #value} to <code>null</code>. 72 */ FixedHolder()73 public FixedHolder() 74 { 75 } 76 77 /** 78 * Constructs an instance of FixedHolder, 79 * initializing {@link #value} to the given <code>BigDecimal</code>. 80 * 81 * @param initial_value a value that will be assigned to the 82 * {@link #value} field. 83 */ FixedHolder(BigDecimal initial_value)84 public FixedHolder(BigDecimal initial_value) 85 { 86 value = initial_value; 87 } 88 89 /** 90 * Fill in the {@link #value } field by reading the required data 91 * from the given stream. For <code>fixed</code>, the functionality 92 * is delegated to 93 * {@link org.omg.CORBA.portable.InputStream#read_fixed}. 94 * 95 * @param input the input stream to read from. 96 */ _read(InputStream input)97 public void _read(InputStream input) 98 { 99 value = input.read_fixed(); 100 } 101 102 /** 103 * Returns the TypeCode, corresponding the CORBA type that is stored 104 * using this holder. The scale and digits are set corresponding 105 * the scale and used digits of the value that is currently stored 106 * or left with default value 0 if the value is not set. 107 */ _type()108 public TypeCode _type() 109 { 110 return new FixedTypeCode(value); 111 } 112 113 /** 114 * Write the {@link #value } field to the given stream. 115 * For <code>fixed</code>, the functionality 116 * is delegated to 117 * {@link org.omg.CORBA.portable.OutputStream#write_fixed(BigDecimal) }. 118 * 119 * @param output the output stream to write into. 120 */ _write(OutputStream output)121 public void _write(OutputStream output) 122 { 123 output.write_fixed(value); 124 } 125 } 126