001    /* CodecFactoryHelper.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.IOP;
040    
041    import gnu.CORBA.OrbRestricted;
042    
043    import org.omg.CORBA.Any;
044    import org.omg.CORBA.BAD_OPERATION;
045    import org.omg.CORBA.BAD_PARAM;
046    import org.omg.CORBA.CompletionStatus;
047    import org.omg.CORBA.MARSHAL;
048    import org.omg.CORBA.TypeCode;
049    import org.omg.CORBA.portable.InputStream;
050    import org.omg.CORBA.portable.OutputStream;
051    
052    /**
053    * The helper operations for the
054    * CORBA object {@link CodecFactory}.
055    *
056    * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057    */
058    public abstract class CodecFactoryHelper
059    {
060      /**
061       * Get the type code of the {@link CodecFactory}.
062       */
063      public static TypeCode type()
064      {
065        return OrbRestricted.Singleton.create_interface_tc(id(), "CodecFactory");
066      }
067    
068      /**
069       * Insert the CodecFactory into the given Any.
070       *
071       * @param any the Any to insert into.
072       * @param that the CodecFactory to insert.
073       */
074      public static void insert(Any any, CodecFactory that)
075      {
076        any.insert_Object(that);
077      }
078    
079      /**
080       * Extract the CodecFactory from given Any.
081       *
082       * @throws BAD_OPERATION if the passed Any does not contain CodecFactory.
083       */
084      public static CodecFactory extract(Any any)
085      {
086        return narrow(any.extract_Object());
087      }
088    
089      /**
090       * Get the CodecFactory repository id.
091       *
092       * @return "IDL:omg.org/IOP/CodecFactory:1.0", always.
093       */
094      public static String id()
095      {
096        return "IDL:omg.org/IOP/CodecFactory:1.0";
097      }
098    
099      /**
100       * Cast the passed object into the CodecFactory. As the CodecFactory
101       * is a local object, this is not different from the java type cast.
102       *
103       * @throws BAD_PARAM if the passed object is not a CodecFactory.
104       */
105      public static CodecFactory narrow(org.omg.CORBA.Object obj)
106      {
107        try
108          {
109            return (CodecFactory) obj;
110          }
111        catch (ClassCastException ex)
112          {
113            BAD_PARAM bad = new BAD_PARAM("CodecFactory expected");
114            bad.initCause(ex);
115            throw bad;
116          }
117      }
118      
119      /**
120       * Narrow the given object to the CodecFactory. For the objects that are
121       * always local, this operation does not differ from the ordinary
122       * {@link #narrow} (ClassCastException will be thrown if narrowing something
123       * different). See OMG issue 4158.
124       * 
125       * @param obj the object to cast.
126       * 
127       * @return the casted CodecFactory.
128       * 
129       * @since 1.5 
130       */
131      public static CodecFactory unchecked_narrow(org.omg.CORBA.Object obj)
132      {
133        return narrow(obj);
134      }    
135    
136      /**
137       * This should read the CodecFactory from the CDR intput stream,
138       * but this is not possible as CodecFactory is a local object.
139       *
140       * @specnote Suns implementation (1.4) throws this exception either.
141       *
142       * @throws MARSHAL, minor code 0 and incomplete, always.
143       */
144      public static CodecFactory read(InputStream input)
145      {
146        throw new MARSHAL(UNSUPPORTED, 0, CompletionStatus.COMPLETED_NO);
147      }
148    
149      /**
150       * This should write the CodecFactory from the CDR intput stream,
151       * but this is not possible as CodecFactory is a local object.
152       *
153       * @specnote Suns implementation (1.4) throws this exception either.
154       *
155       * @throws MARSHAL, minor code 0 and incomplete, always.
156       */
157      public static void write(OutputStream output, CodecFactory value)
158      {
159        throw new MARSHAL(UNSUPPORTED, 0, CompletionStatus.COMPLETED_NO);
160      }
161    
162      private static String UNSUPPORTED =
163        "The operation is unsupported for CodecFactory because it is a local object";
164    }