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 org.omg.CORBA.Any;
  42: import org.omg.CORBA.BAD_PARAM;
  43: import org.omg.CORBA.MARSHAL;
  44: import org.omg.CORBA.ORB;
  45: import org.omg.CORBA.TypeCode;
  46: import org.omg.CORBA.portable.InputStream;
  47: import org.omg.CORBA.portable.OutputStream;
  48: 
  49: /**
  50:  * The helper operations for the CORBA object {@link Current}.
  51:  *
  52:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  53:  */
  54: public abstract class CurrentHelper
  55: {
  56:   /**
  57:    * The cached {@link Current} typecode, computed once.
  58:    */
  59:   private static TypeCode typeCode;
  60: 
  61:   /**
  62:    * Get the type code of the {@link Current}.
  63:    */
  64:   public static TypeCode type()
  65:   {
  66:     if (typeCode == null)
  67:       {
  68:         typeCode = ORB.init().create_interface_tc(id(), "Current");
  69:       }
  70:     return typeCode;
  71:   }
  72: 
  73:   /**
  74:    * Insert the Current into the given Any.
  75:    *
  76:    * @param any the Any to insert into.
  77:    * @param that the Current to insert.
  78:    */
  79:   public static void insert(Any any, Current that)
  80:   {
  81:     any.insert_Object(that);
  82:   }
  83: 
  84:   /**
  85:    * Extract the Current from given Any.
  86:    *
  87:    * @throws BAD_OPERATION if the passed Any does not contain Current.
  88:    */
  89:   public static Current extract(Any any)
  90:   {
  91:     return narrow(any.extract_Object());
  92:   }
  93: 
  94:   /**
  95:    * Get the Current repository id.
  96:    *
  97:    * @return "org.omg.PortableInterceptor.CurrentOperations", always.
  98:    */
  99:   public static String id()
 100:   {
 101:     return "IDL:omg.org/PortableInterceptor/Current:1.0";
 102:   }
 103: 
 104:   /**
 105:    * Cast the passed object into the Current.
 106:    *
 107:    * @param obj the object to narrow.
 108:    * @return narrowed instance.
 109:    * @throws BAD_PARAM if the passed object is not a Current.
 110:    */
 111:   public static Current narrow(org.omg.CORBA.Object obj)
 112:   {
 113:     if (obj == null)
 114:       {
 115:         return null;
 116:       }
 117:     else if (obj instanceof Current)
 118:       {
 119:         return (Current) obj;
 120:       }
 121:     else
 122:       {
 123:         throw new BAD_PARAM("Not a Current");
 124:       }
 125:   }
 126: 
 127:   /**
 128:    * Not supported for compatibility reasons.
 129:    *
 130:    * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
 131:    *
 132:    * @throws MARSHAL always.
 133:    */
 134:   public static Current read(InputStream input)
 135:   {
 136:     throw new MARSHAL();
 137:   }
 138: 
 139:   /**
 140:    * Not supported for compatibility reasons.
 141:    *
 142:    * @specnote Not supported by Sun at least till jdk 1.5 inclusive.
 143:    *
 144:    * @throws MARSHAL always.
 145:    */
 146:   public static void write(OutputStream output, Current value)
 147:   {
 148:     throw new MARSHAL();
 149:   }