001    /* FixedHolder.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.CORBA;
040    
041    import gnu.CORBA.typecodes.FixedTypeCode;
042    
043    import java.math.BigDecimal;
044    
045    import org.omg.CORBA.portable.InputStream;
046    import org.omg.CORBA.portable.OutputStream;
047    import 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     */
060    public 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    }