Source for org.omg.CORBA.PolicyTypeHelper

   1: /* PolicyTypeHelper.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 gnu.CORBA.OrbRestricted;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.ORB;
  46: import org.omg.CORBA.StructMember;
  47: import org.omg.CORBA.TCKind;
  48: import org.omg.CORBA.TypeCode;
  49: import org.omg.CORBA.portable.InputStream;
  50: import org.omg.CORBA.portable.OutputStream;
  51: 
  52: /**
  53: * A helper operations for the policy type. A policy type is an integer
  54: * constant and needs no helper, but the one is included to
  55: * to facilitate the automated code handling.
  56: *
  57: * @specnote In this implementation, this class is not in use. Its "logical"
  58: * place would be {@link ORB}, having the PolicyType type. These parameters
  59: * are declarded as <coe>int</code> in the ORB interface.
  60: *
  61: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  62: */
  63: public abstract class PolicyTypeHelper
  64: {
  65:   /**
  66:    * Create the PolicyType typecode (alias of CORBA ulong, named "PolicyType".
  67:    */
  68:   public static TypeCode type()
  69:   {
  70:     ORB orb = OrbRestricted.Singleton;
  71:     return orb.create_alias_tc(id(), "PolicyType",
  72:                                orb.get_primitive_tc(TCKind.tk_ulong)
  73:                               );
  74:   }
  75: 
  76:   /**
  77:   * Insert the int into the given Any.
  78:   */
  79:   public static void insert(Any any, int that)
  80:   {
  81:     any.insert_ulong(that);
  82:   }
  83: 
  84:   /**
  85:    * Extract the int from given Any.
  86:    *
  87:    * @throws BAD_OPERATION if the passed Any does not contain int.
  88:    */
  89:   public static int extract(Any any)
  90:   {
  91:     return any.extract_ulong();
  92:   }
  93: 
  94:   /**
  95:    * Get the int repository id.
  96:    *
  97:    * @return "IDL:omg.org/CORBA/PolicyType:1.0", always.
  98:    */
  99:   public static String id()
 100:   {
 101:     return "IDL:omg.org/CORBA/PolicyType:1.0";
 102:   }
 103: 
 104:   /**
 105:    * Read the int (policy type) from the CDR intput stream.
 106:    *
 107:    * @param input a org.omg.CORBA.portable stream to read from.
 108:    */
 109:   public static int read(InputStream input)
 110:   {
 111:     return input.read_ulong();
 112:   }
 113: 
 114:   /**
 115:    * Write the int (policy type) to the CDR output stream.
 116:    *
 117:    * @param output a org.omg.CORBA.portable stream stream to write into.
 118:    * @param value a value to write.
 119:    */
 120:   public static void write(OutputStream output, int value)
 121:   {
 122:     output.write_ulong(value);
 123:   }