Source for org.omg.CORBA.ObjectHolder

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