gomp-20050608-branch/libjava/classpath/org/omg/PortableInterceptor/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.PortableInterceptor;
  40
  41 import gnu.CORBA.Minor;
  42
  43 import org.omg.CORBA.Any;
  44 import org.omg.CORBA.BAD_PARAM;
  45 import org.omg.CORBA.MARSHAL;
  46 import org.omg.CORBA.ORB;
  47 import org.omg.CORBA.TypeCode;
  48 import org.omg.CORBA.portable.InputStream;
  49 import org.omg.CORBA.portable.OutputStream;
  50 import org.omg.PortableServer.ServantActivator;
  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 cached {@link Current} typecode, computed once.
  61    */
  62   private static TypeCode typeCode;
  63
  64   /**
  65    * Get the type code of the {@link Current}.
  66    */
  67   public static TypeCode type()
  68   {
  69     if (typeCode == null)
  70       {
  71         typeCode = ORB.init().create_interface_tc(id(), "Current");
  72       }
  73     return typeCode;
  74   }
  75
  76   /**
  77    * Insert the Current into the given Any.
  78    *
  79    * @param any the Any to insert into.
  80    * @param that the Current to insert.
  81    */
  82   public static void insert(Any any, Current that)
  83   {
  84     any.insert_Object(that);
  85   }
  86
  87   /**
  88    * Extract the Current from given Any.
  89    *
  90    * @throws BAD_OPERATION if the passed Any does not contain Current.
  91    */
  92   public static Current extract(Any any)
  93   {
  94     return narrow(any.extract_Object());
  95   }
  96
  97   /**
  98    * Get the Current repository id.
  99    *
 100    * @return "org.omg.PortableInterceptor.CurrentOperations", always.
 101    */
 102   public static String id()
 103   {
 104     return "IDL:omg.org/PortableInterceptor/Current:1.0";
 105   }
 106
 107   /**
 108    * Cast the passed object into the Current.
 109    *
 110    * @param obj the object to narrow.
 111    * @return narrowed instance.
 112    * @throws BAD_PARAM if the passed object is not a Current.
 113    */
 114   public static Current narrow(org.omg.CORBA.Object obj)
 115   {
 116     if (obj == null)
 117       {
 118         return null;
 119       }
 120     else if (obj instanceof Current)
 121       {
 122         return (Current) obj;
 123       }
 124     else
 125       {
 126         throw new BAD_PARAM("Not a Current");
 127       }
 128   }
 129
 130   /**
 131    * Narrow the given object to the Current. For the objects that are
 132    * always local, this operation does not differ from the ordinary
 133    * {@link #narrow} (ClassCastException will be thrown if narrowing something
 134    * different).
 135    *
 136    * @param obj the object to cast.
 137    *
 138    * @return the casted Current.
 139    *
 140    * @since 1.5
 141    *
 142    * @see OMG issue 4158.
 143    */
 144   public static Current unchecked_narrow(org.omg.CORBA.Object obj)
 145   {
 146     return narrow(obj);
 147   }
 148
 149   /**
 150    * Not supported for compatibility reasons.
 151    *
 152    * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
 153    *
 154    * @throws MARSHAL always.
 155    */
 156   public static Current read(InputStream input)
 157   {
 158     MARSHAL m = new MARSHAL("Inappropriate");
 159     m.minor = Minor.Inappropriate;
 160     throw m;
 161   }
 162
 163   /**
 164    * Not supported for compatibility reasons.
 165    *
 166    * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
 167    *
 168    * @throws MARSHAL always.
 169    */
 170   public static void write(OutputStream output, Current value)
 171   {
 172     MARSHAL m = new MARSHAL("Inappropriate");
 173     m.minor = Minor.Inappropriate;
 174     throw m;
 175   }
 176 }