Source for org.omg.PortableInterceptor.CurrentHelper

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