001    /* PolicyErrorHelper.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.CORBA;
040    
041    import gnu.CORBA.Minor;
042    import gnu.CORBA.OrbRestricted;
043    
044    import org.omg.CORBA.Any;
045    import org.omg.CORBA.BAD_OPERATION;
046    import org.omg.CORBA.ORB;
047    import org.omg.CORBA.StructMember;
048    import org.omg.CORBA.TCKind;
049    import org.omg.CORBA.TypeCode;
050    import org.omg.CORBA.portable.InputStream;
051    import org.omg.CORBA.portable.OutputStream;
052    
053    /**
054    * The helper operations for the exception {@link PolicyError}.
055    *
056    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057    */
058    public abstract class PolicyErrorHelper
059    {
060      /**
061       * Create the PolicyError typecode. The typecode defines a structure, named
062       * "PolicyError", containing the PolicyErrorCode (alias int, see 
063       * {@link PolicyErrorCodeHelper}) field, named "reason".
064       */
065      public static TypeCode type()
066      {
067        ORB orb = OrbRestricted.Singleton;
068        StructMember[] members = new StructMember[ 1 ];
069        
070        TypeCode field;
071        
072        field =
073          orb.create_alias_tc("IDL:omg.org/CORBA/PolicyErrorCode:1.0",
074                              "PolicyErrorCode", orb.get_primitive_tc(TCKind.tk_short)
075          );
076        members [ 0 ] = new StructMember("reason", field, null);
077        return orb.create_exception_tc(id(), "PolicyError", members);
078      }
079    
080      /**
081      * Insert the PolicyError into the given Any.
082      * This method uses the PolicyErrorHolder.
083      *
084      * @param any the Any to insert into.
085      * @param that the PolicyError to insert.
086      */
087      public static void insert(Any any, PolicyError that)
088      {
089        any.insert_Streamable(new PolicyErrorHolder(that));
090      }
091    
092      /**
093       * Extract the PolicyError from given Any.
094       * This method uses the PolicyErrorHolder.
095       *
096       * @throws BAD_OPERATION if the passed Any does not contain PolicyError.
097       */
098      public static PolicyError extract(Any any)
099      {
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    }