gomp-20050608-branch/libjava/classpath/org/omg/PortableInterceptor/ForwardRequestHelper.java

   1 /* ForwardRequestHelper.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.PortableInterceptor;
  40
  41 import gnu.CORBA.Minor;
  42 import gnu.CORBA.Interceptor.ForwardRequestHolder;
  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.ObjectHelper;
  48 import org.omg.CORBA.StructMember;
  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 ForwardRequest}.
  55  *
  56  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57  */
  58 public abstract class ForwardRequestHelper
  59 {
  60   /**
  61    * The cached typecode value, computed only once.
  62    */
  63   private static TypeCode typeCode;
  64
  65   /**
  66        * Create the ForwardRequest typecode (structure, named "ForwardRequest"). The
  67    * typecode states that the structure contains the following fields: forward.
  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 = ObjectHelper.type();
  77         members [ 0 ] = new StructMember("forward", field, null);
  78         typeCode = orb.create_exception_tc(id(), "ForwardRequest", members);
  79       }
  80     return typeCode;
  81   }
  82
  83   /**
  84    * Insert the ForwardRequest into the given Any. This method uses the
  85    * ForwardRequestHolder.
  86    *
  87    * @param any the Any to insert into.
  88    * @param that the ForwardRequest to insert.
  89    */
  90   public static void insert(Any any, ForwardRequest that)
  91   {
  92     any.insert_Streamable(new ForwardRequestHolder(that));
  93   }
  94
  95   /**
  96    * Extract the ForwardRequest from given Any. This method uses the
  97    * ForwardRequestHolder.
  98    *
  99    * @throws BAD_OPERATION if the passed Any does not contain ForwardRequest.
 100    */
 101   public static ForwardRequest extract(Any any)
 102   {
 103     try
 104       {
 105         return ((ForwardRequestHolder) any.extract_Streamable()).value;
 106       }
 107     catch (ClassCastException cex)
 108       {
 109         BAD_OPERATION bad = new BAD_OPERATION(id() + " expected");
 110         bad.minor = Minor.Any;
 111         bad.initCause(cex);
 112         throw bad;
 113       }
 114   }
 115
 116   /**
 117    * Get the ForwardRequest repository id.
 118    *
 119    * @return "IDL:omg.org/PortableInterceptor/ForwardRequest:1.0", always.
 120    */
 121   public static String id()
 122   {
 123     return "IDL:omg.org/PortableInterceptor/ForwardRequest:1.0";
 124   }
 125
 126   /**
 127    * Read the exception from the CDR intput stream.
 128    *
 129    * @param input a org.omg.CORBA.portable stream to read from.
 130    */
 131   public static ForwardRequest read(InputStream input)
 132   {
 133     // Read (and discard) the exception repository id.
 134     input.read_string();
 135
 136     ForwardRequest value = new ForwardRequest();
 137
 138     value.forward = input.read_Object();
 139     return value;
 140   }
 141
 142   /**
 143    * Write the exception to the CDR output stream.
 144    *
 145    * @param output a org.omg.CORBA.portable stream stream to write into.
 146    * @param value a value to write.
 147    */
 148   public static void write(OutputStream output, ForwardRequest value)
 149   {
 150     // Write the exception repository id.
 151     output.write_string(id());
 152     output.write_Object(value.forward);
 153   }
 154 }