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