001/* FixedHolder.java -- 002 Copyright (C) 2005, 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package org.omg.CORBA; 040 041import gnu.CORBA.typecodes.FixedTypeCode; 042 043import java.math.BigDecimal; 044 045import org.omg.CORBA.portable.InputStream; 046import org.omg.CORBA.portable.OutputStream; 047import org.omg.CORBA.portable.Streamable; 048 049/** 050 * A holder for CORBA <code>fixed</code> that is mapped into 051 * java <code>BigDecimal</code>. 052 * 053 * The holders have several application areas. The end user usually 054 * sees them implementing CORBA methods where the primitive type 055 * is passed by reference. While CORBA (or, for example, C) supports 056 * this, the java does not and a wrapper class is required. 057 * 058 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org) 059 */ 060public final class FixedHolder 061 implements Streamable 062{ 063 /** 064 * The <code>BigDecimal</code> (CORBA <code>fixed</code>) value, 065 * held by this FixedHolder. 066 */ 067 public BigDecimal value; 068 069 /** 070 * Constructs an instance of FixedHolder, 071 * initializing {@link #value} to <code>null</code>. 072 */ 073 public FixedHolder() 074 { 075 } 076 077 /** 078 * Constructs an instance of FixedHolder, 079 * initializing {@link #value} to the given <code>BigDecimal</code>. 080 * 081 * @param initial_value a value that will be assigned to the 082 * {@link #value} field. 083 */ 084 public FixedHolder(BigDecimal initial_value) 085 { 086 value = initial_value; 087 } 088 089 /** 090 * Fill in the {@link #value } field by reading the required data 091 * from the given stream. For <code>fixed</code>, the functionality 092 * is delegated to 093 * {@link org.omg.CORBA.portable.InputStream#read_fixed}. 094 * 095 * @param input the input stream to read from. 096 */ 097 public void _read(InputStream input) 098 { 099 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 */ 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 */ 121 public void _write(OutputStream output) 122 { 123 output.write_fixed(value); 124 } 125}