Source for org.omg.CORBA.PolicyHelper

   1: /* PolicyHelper.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
  54: * CORBA object {@link Policy}.
  55: *
  56: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57: */
  58: public abstract class PolicyHelper
  59: {
  60:   /**
  61:    * The cached {@link Policy} typecode, computed once.
  62:    */
  63:   private static TypeCode typeCode;
  64: 
  65:   /**
  66:    * Get the type code of the {@link Policy}.
  67:    *
  68:    * @return interface typecode, named "Policy".
  69:    */
  70:   public static TypeCode type()
  71:   {
  72:     if (typeCode == null)
  73:       typeCode = ORB.init().create_interface_tc(id(), "Policy");
  74:     return typeCode;
  75:   }
  76: 
  77:   /**
  78:    * Insert the Policy into the given Any.
  79:    *
  80:    * @param any the Any to insert into.
  81:    * @param that the Policy to insert.
  82:    */
  83:   public static void insert(Any any, Policy that)
  84:   {
  85:     any.insert_Streamable(new PolicyHolder(that));
  86:   }
  87: 
  88:   /**
  89:    * Extract the Policy from given Any.
  90:    *
  91:    * @throws BAD_OPERATION if the passed Any does not contain Policy.
  92:    */
  93:   public static Policy extract(Any any)
  94:   {
  95:     try
  96:       {
  97:         PolicyHolder h = (PolicyHolder) any.extract_Streamable();
  98:         return h.value;
  99:       }
 100:     catch (ClassCastException ex)
 101:       {
 102:         throw new BAD_OPERATION("Policy expected");
 103:       }
 104:   }
 105: 
 106:   /**
 107:    * Get the Policy repository id.
 108:    *
 109:    * @return "IDL:omg.org/CORBA/Policy:1.0", always.
 110:    */
 111:   public static String id()
 112:   {
 113:     return "IDL:omg.org/CORBA/Policy:1.0";
 114:   }
 115: 
 116:   /**
 117:    * Cast the passed object into the Policy. If the
 118:    * object has a different java type, create an instance
 119:    * of the _PolicyStub, using the same delegate, as for
 120:    * the passed parameter. Hence, unlike java type cast,
 121:    * this method may return a different object, than has been passed.
 122:    *
 123:    * @param obj the object to narrow.
 124:    * @return narrowed instance.
 125:    * @throws BAD_PARAM if the passed object is not a Policy.
 126:    */
 127:   public static Policy narrow(org.omg.CORBA.Object obj)
 128:   {
 129:     if (obj == null)
 130:       return null;
 131:     else if (obj instanceof Policy)
 132:       return (Policy) obj;
 133:     else
 134:       {
 135:         // Check for the policy id cannot be performed because
 136:         // this helper must read various subclasses of the Policy,
 137:         // and the IOR profile currently supports only one id.
 138: 
 139:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 140:         return new _PolicyStub(delegate);
 141:       }
 142:   }
 143: 
 144:   /**
 145:    * Read the object from the CDR intput stream (IOR profile expected).
 146:    *
 147:    * @param input a org.omg.CORBA.portable stream to read from.
 148:    */
 149:   public static Policy read(InputStream input)
 150:   {
 151:     return narrow(input.read_Object());
 152:   }
 153: 
 154:   /**
 155:    * Write the object to the CDR output stream (as IOR profile).
 156:    *
 157:    * @param output a org.omg.CORBA.portable stream stream to write into.
 158:    * @param value a value to write.
 159:    */
 160:   public static void write(OutputStream output, Policy value)
 161:   {
 162:     output.write_Object(value);
 163:   }