Frames | No Frames |
1: /* FixedHolder.java -- 2: Copyright (C) 2005 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: import gnu.CORBA.typecodes.PrimitiveTypeCode; 43: 44: import java.math.BigDecimal; 45: 46: import org.omg.CORBA.portable.InputStream; 47: import org.omg.CORBA.portable.OutputStream; 48: import org.omg.CORBA.portable.Streamable; 49: 50: /** 51: * A holder for CORBA <code>fixed</code> that is mapped into 52: * java <code>BigDecimal</code>. 53: * 54: * The holders have several application areas. The end user usually 55: * sees them implementing CORBA methods where the primitive type 56: * is passed by reference. While CORBA (or, for example, C) supports 57: * this, the java does not and a wrapper class is required. 58: * 59: * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 60: */ 61: public final class FixedHolder 62: implements Streamable 63: { 64: /** 65: * The <code>BigDecimal</code> (CORBA <code>fixed</code>) value, 66: * held by this FixedHolder. 67: */ 68: public BigDecimal value; 69: 70: /** 71: * Constructs an instance of FixedHolder, 72: * initializing {@link #value} to <code>null</code>. 73: */ 74: public FixedHolder() 75: { 76: } 77: 78: /** 79: * Constructs an instance of FixedHolder, 80: * initializing {@link #value} to the given <code>BigDecimal</code>. 81: * 82: * @param initial_value a value that will be assigned to the 83: * {@link #value} field. 84: */ 85: public FixedHolder(BigDecimal initial_value) 86: { 87: value = initial_value; 88: } 89: 90: /** 91: * Fill in the {@link value } field by reading the required data 92: * from the given stream. For <code>fixed</code>, the functionality 93: * is delegated to 94: * {@link org.omg.CORBA.portable.InputStream#read_fixed}. 95: * 96: * @param input the input stream to read from. 97: */ 98: public void _read(InputStream input) 99: { 100: value = input.read_fixed(); 101: } 102: 103: /** 104: * Returns the TypeCode, corresponding the CORBA type that is stored 105: * using this holder. The scale and digits are set corresponding 106: * the scale and used digits of the value that is currently stored 107: * or left with default value 0 if the value is not set. 108: */ 109: public TypeCode _type() 110: { 111: return new FixedTypeCode(value); 112: } 113: 114: /** 115: * Write the {@link value } field to the given stream. 116: * For <code>fixed</code>, the functionality 117: * is delegated to 118: * {@link org.omg.CORBA.portable.OutputStream#write_fixed(BigDecimal) }. 119: * 120: * @param output the output stream to write into. 121: */ 122: public void _write(OutputStream output) 123: { 124: output.write_fixed(value); 125: } 126: }