gomp-20050608-branch/libjava/classpath/org/omg/CORBA/ValueBaseHelper.java

   1 /* ValueBaseHelper.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.CDR.Vio;
  42 import gnu.CORBA.typecodes.RecordTypeCode;
  43
  44 import org.omg.CORBA.portable.InputStream;
  45 import org.omg.CORBA.portable.OutputStream;
  46
  47 import java.io.Serializable;
  48
  49 /**
  50  * A helper operations for the value base type ({@link ValueBase}).
  51  *
  52  * @since 1.3
  53  *
  54  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  55  */
  56 public abstract class ValueBaseHelper
  57 {
  58   /**
  59    * Extract the value type from the given Any.
  60    *
  61    * @param a the Any to extract from.
  62    *
  63    * @return the extracted value type.
  64    */
  65   public static Serializable extract(Any a)
  66   {
  67     return a.extract_Value();
  68   }
  69
  70   /**
  71    * Return the value base helper repository id.
  72    *
  73    * @return IDL:omg.org/CORBA/ValueBase:1.0, always.
  74    */
  75   public static String id()
  76   {
  77     return "IDL:omg.org/CORBA/ValueBase:1.0";
  78   }
  79
  80   /**
  81    * Insert the value base that is Serializable into
  82    * the given Any.
  83    *
  84    * @param a the Any to insert into.
  85    * @param that the value base to insert.
  86    */
  87   public static void insert(Any a, Serializable that)
  88   {
  89     a.insert_Value(that);
  90   }
  91
  92   /**
  93    * Read the value base from the given input stream.
  94    *
  95    * @param input a stream to read from.
  96    *
  97    * @return the loaded value.
  98    *
  99    * @throws MARSHAL if the reading has failed due any reason.
 100    */
 101   public static Serializable read(InputStream input)
 102   {
 103     return Vio.read(input);
 104   }
 105
 106   /**
 107    * Get the typecode of the value type.
 108    * @return
 109    */
 110   public static TypeCode type()
 111   {
 112     RecordTypeCode r = new RecordTypeCode(TCKind.tk_value);
 113     return r;
 114   }
 115
 116   /**
 117    * Write the value base into the given stream.
 118    *
 119    * If the passed value implements the {@link CustomMarshal},
 120    * the helper uses {@link CustomMarshal#marshal}
 121    * to write the content in a user defined way. Otherwise,
 122    * this implementation initialises the {@link ObjectOutputStream}
 123    * and writes through it.
 124    *
 125    * @param output a stream to write to.
 126    *
 127    * @param value a value to write.
 128    *
 129    * @throws MARSHAL if the writing failed due any reason.
 130    */
 131   public static void write(OutputStream output, Serializable value)
 132   {
 133     Vio.write(output, value);
 134   }
 135 }