libjava/classpath/org/omg/CORBA/PolicyErrorHelper.java

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