Source for org.omg.CORBA.PolicyErrorHelper

   1: /* PolicyErrorHelper.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.Minor;
  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: * The helper operations for the exception {@link PolicyError}.
  54: *
  55: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56: */
  57: public abstract class PolicyErrorHelper
  58: {
  59:   /**
  60:    * The cached typecode value, computed only once.
  61:    */
  62:   private static TypeCode typeCode;
  63: 
  64:   /**
  65:    * Create the PolicyError typecode. The typecode defines a structure, named
  66:    * "PolicyError", containing the {@link PolicyErrorCode} (alias int) field,
  67:    * named "reason".
  68:    */
  69:   public static TypeCode type()
  70:   {
  71:     if (typeCode == null)
  72:       {
  73:         ORB orb = ORB.init();
  74:         StructMember[] members = new StructMember[ 1 ];
  75: 
  76:         TypeCode field;
  77: 
  78:         field =
  79:           orb.create_alias_tc("IDL:omg.org/CORBA/PolicyErrorCode:1.0",
  80:             "PolicyErrorCode", orb.get_primitive_tc(TCKind.tk_short)
  81:           );
  82:         members [ 0 ] = new StructMember("reason", field, null);
  83:         typeCode = orb.create_exception_tc(id(), "PolicyError", members);
  84:       }
  85:     return typeCode;
  86:   }
  87: 
  88:   /**
  89:   * Insert the PolicyError into the given Any.
  90:   * This method uses the PolicyErrorHolder.
  91:   *
  92:   * @param any the Any to insert into.
  93:   * @param that the PolicyError to insert.
  94:   */
  95:   public static void insert(Any any, PolicyError that)
  96:   {
  97:     any.insert_Streamable(new PolicyErrorHolder(that));
  98:   }
  99: 
 100:   /**
 101:    * Extract the PolicyError from given Any.
 102:    * This method uses the PolicyErrorHolder.
 103:    *
 104:    * @throws BAD_OPERATION if the passed Any does not contain PolicyError.
 105:    */
 106:   public static PolicyError extract(Any any)
 107:   {
 108:     try
 109:       {
 110:         return ((PolicyErrorHolder) any.extract_Streamable()).value;
 111:       }
 112:     catch (ClassCastException cex)
 113:       {
 114:         BAD_OPERATION bad = new BAD_OPERATION("PolicyError expected");
 115:         bad.minor = Minor.Any;
 116:         bad.initCause(cex);
 117:         throw bad;
 118:       }
 119:   }
 120: 
 121:   /**
 122:    * Get the PolicyError repository id.
 123:    *
 124:    * @return "IDL:omg.org/CORBA/PolicyError:1.0", always.
 125:    */
 126:   public static String id()
 127:   {
 128:     return "IDL:omg.org/CORBA/PolicyError:1.0";
 129:   }
 130: 
 131:   /**
 132:    * Read the exception from the CDR intput stream.
 133:    *
 134:    * @param input a org.omg.CORBA.portable stream to read from.
 135:    */
 136:   public static PolicyError read(InputStream input)
 137:   {
 138:     // Read the exception repository id.
 139:     String id = input.read_string();
 140:     PolicyError value = new PolicyError();
 141: 
 142:     value.reason = input.read_short();
 143:     return value;
 144:   }
 145: 
 146:   /**
 147:    * Write the exception to the CDR output stream.
 148:    *
 149:    * @param output a org.omg.CORBA.portable stream stream to write into.
 150:    * @param value a value to write.
 151:    */
 152:   public static void write(OutputStream output, PolicyError value)
 153:   {
 154:     // Write the exception repository id.
 155:     output.write_string(id());
 156:     output.write_short(value.reason);
 157:   }