001    /* DynAnyHelper.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    
040    package org.omg.DynamicAny;
041    
042    import gnu.CORBA.OrbRestricted;
043    
044    import org.omg.CORBA.BAD_OPERATION;
045    import org.omg.CORBA.BAD_PARAM;
046    import org.omg.CORBA.TypeCode;
047    import org.omg.CORBA.Any;
048    import org.omg.CORBA.portable.InputStream;
049    import org.omg.CORBA.MARSHAL;
050    import org.omg.CORBA.portable.OutputStream;
051    
052    /**
053     * The helper operations for {@link DynAny}. Following the 1.5 JDK
054     * specifications, DynAny is always a local object, so the two methods of this
055     * helper ({@link #read} and {@link #write} are not in use, always throwing
056     * {@link MARSHAL}.
057     * 
058     * @specnote always throwing MARSHAL in read and write ensures compatibility
059     * with other popular implementations like Sun's.
060     * 
061     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
062     */
063    public abstract class DynAnyHelper
064    {
065      /**
066       * Cast the passed object into the DynAny. As DynAny is a local object, the
067       * method just uses java type cast.
068       * 
069       * @param obj the object to narrow.
070       * @return narrowed instance.
071       * @throws BAD_PARAM if the passed object is not a DynAny.
072       */
073      public static DynAny narrow(org.omg.CORBA.Object obj)
074      {
075        try
076          {
077            return (DynAny) obj;
078          }
079        catch (ClassCastException cex)
080          {
081            throw new BAD_PARAM(obj.getClass().getName() + " is not a DynAny");
082          }
083      }
084      
085      /**
086       * Narrow the given object to the DynAny. For the objects that are
087       * always local, this operation does not differ from the ordinary
088       * {@link #narrow} (ClassCastException will be thrown if narrowing something
089       * different). See also OMG issue 4158.
090       * 
091       * @param obj the object to cast.
092       * 
093       * @return the casted DynAny.
094       * 
095       * @since 1.5 
096       */
097      public static DynAny unchecked_narrow(org.omg.CORBA.Object obj)
098      {
099        return narrow(obj);
100      }    
101    
102      /**
103       * Get the type code of the {@link DynAny}.
104       */
105      public static TypeCode type()
106      {
107        return OrbRestricted.Singleton.create_interface_tc(id(), "DynAny");
108      }
109    
110      /**
111       * Insert the DynAny into the given Any.
112       * 
113       * @param any the Any to insert into.
114       * 
115       * @param that the DynAny to insert.
116       */
117      public static void insert(Any any, DynAny that)
118      {
119        any.insert_Object(that);
120      }
121    
122      /**
123       * Extract the DynAny from given Any.
124       * 
125       * @throws BAD_OPERATION if the passed Any does not contain DynAny.
126       */
127      public static DynAny extract(Any any)
128      {
129        return narrow(any.extract_Object());
130      }
131    
132      /**
133       * Get the DynAny repository id.
134       * 
135       * @return "IDL:omg.org/DynamicAny/DynAny:1.0", always.
136       */
137      public static String id()
138      {
139        return "IDL:omg.org/DynamicAny/DynAny:1.0";
140      }
141    
142      /**
143       * This should read DynAny from the CDR input stream, but (following the JDK
144       * 1.5 API) it does not.
145       * 
146       * @param input a org.omg.CORBA.portable stream to read from.
147       * 
148       * @specenote Sun throws the same exception.
149       * 
150       * @throws MARSHAL always.
151       */
152      public static DynAny read(InputStream input)
153      {
154        throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
155      }
156    
157      /**
158       * This should read DynAny from the CDR input stream, but (following the JDK
159       * 1.5 API) it does not.
160       * 
161       * @param output a org.omg.CORBA.portable stream to write into.
162       * 
163       * @specenote Sun throws the same exception.
164       * 
165       * @throws MARSHAL always.
166       */
167      public static void write(OutputStream output, DynAny value)
168      {
169        throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
170      }
171    }