libjava/classpath/org/omg/CORBA/CurrentHelper.java

   1 /* CurrentHelper.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 org.omg.CORBA.Any;
  42 import org.omg.CORBA.BAD_OPERATION;
  43 import org.omg.CORBA.ORB;
  44 import org.omg.CORBA.StructMember;
  45 import org.omg.CORBA.TCKind;
  46 import org.omg.CORBA.TypeCode;
  47 import org.omg.CORBA.portable.Delegate;
  48 import org.omg.CORBA.portable.InputStream;
  49 import org.omg.CORBA.portable.ObjectImpl;
  50 import org.omg.CORBA.portable.OutputStream;
  51
  52 /**
  53 * The helper operations for the CORBA object {@link Current}.
  54 *
  55 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56 */
  57 public abstract class CurrentHelper
  58 {
  59   /**
  60    * The Current stub (proxy), used on the client side.
  61    * The {@link Current} methods should contain the code for remote
  62    * invocaton. As there are no methods defined, this class is only
  63    * used for the formal support of the
  64    * {@link #narrow(org.omg.CORBA.Object)}.
  65    */
  66   private static class _CurrentStub
  67     extends ObjectImpl
  68     implements Current
  69   {
  70     /**
  71      * Create the naming context stub with the given delegate.
  72      */
  73     public _CurrentStub(Delegate delegate)
  74     {
  75       _set_delegate(delegate);
  76     }
  77
  78     /**
  79      * Return the array of repository ids for this object.
  80      */
  81     public String[] _ids()
  82     {
  83       return new String[] { id() };
  84     }
  85   }
  86
  87   /**
  88    * The cached {@link Current} typecode, computed once.
  89    */
  90   private static TypeCode typeCode;
  91
  92   /**
  93    * Get the type code of the {@link Current}.
  94    */
  95   public static TypeCode type()
  96   {
  97     if (typeCode == null)
  98       typeCode = ORB.init().create_interface_tc(id(), "Current");
  99     return typeCode;
 100   }
 101
 102   /**
 103    * Insert the Current into the given Any.
 104    *
 105    * @param any the Any to insert into.
 106    * @param that the Current to insert.
 107    */
 108   public static void insert(Any any, Current that)
 109   {
 110     any.insert_Object(that);
 111   }
 112
 113   /**
 114    * Extract the Current from given Any.
 115    *
 116    * @throws BAD_OPERATION if the passed Any does not contain Current.
 117    */
 118   public static Current extract(Any any)
 119   {
 120     return narrow(any.extract_Object());
 121   }
 122
 123   /**
 124    * Get the Current repository id.
 125    *
 126    * @return "IDL:omg.org/CORBA/Current:1.0", always.
 127    */
 128   public static String id()
 129   {
 130     return "IDL:omg.org/CORBA/Current:1.0";
 131   }
 132
 133   /**
 134    * Cast the passed object into the Current. If the
 135    * object has a different java type, create an instance
 136    * of the _CurrentStub, using the same delegate, as for
 137    * the passed parameter. Hence, unlike java type cast,
 138    * this method may return a different object, than has been passed.
 139    *
 140    * @param obj the object to narrow.
 141    * @return narrowed instance.
 142    *
 143    * @throws BAD_PARAM if the passed object is not a Current.
 144    */
 145   public static Current narrow(org.omg.CORBA.Object obj)
 146   {
 147     if (obj == null)
 148       return null;
 149     else if (obj instanceof Current)
 150       return (Current) obj;
 151     else if (!obj._is_a(id()))
 152       throw new BAD_PARAM("Not a Current");
 153     else
 154       {
 155         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 156         return new _CurrentStub(delegate);
 157       }
 158   }
 159
 160   /**
 161    * Read the Current from the CDR intput stream (IOR profile expected).
 162    *
 163    * @param input a org.omg.CORBA.portable stream to read from.
 164    */
 165   public static Current read(InputStream input)
 166   {
 167     return narrow(input.read_Object());
 168   }
 169
 170   /**
 171    * Write the Current to the CDR output stream (as IOR profile).
 172    *
 173    * @param output a org.omg.CORBA.portable stream stream to write into.
 174    * @param value a value to write.
 175    */
 176   public static void write(OutputStream output, Current value)
 177   {
 178     output.write_Object(value);
 179   }
 180 }