001    /* DynAnySeq.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.DynamicAny;
040    
041    import gnu.CORBA.DynAnySeqHolder;
042    import gnu.CORBA.Minor;
043    import gnu.CORBA.OrbRestricted;
044    
045    import org.omg.CORBA.Any;
046    import org.omg.CORBA.BAD_OPERATION;
047    import org.omg.CORBA.MARSHAL;
048    import org.omg.CORBA.ORB;
049    import org.omg.CORBA.TypeCode;
050    import org.omg.CORBA.portable.InputStream;
051    import org.omg.CORBA.portable.OutputStream;
052    
053    /**
054     * A helper operations for the array of {@link DynAny} (DynAny[]).
055     * Following the 1.5 JDK specifications, DynAny (and hence an sequence of
056     * DynAny's) is always a local object, so the two methods of this helper
057     * ({@link #read} and {@link #write} are not in use, always throwing
058     * {@link MARSHAL}.
059     *
060     * @specnote always throwing MARSHAL in read and write ensures compatibility
061     * with other popular implementations like Sun's.
062     *
063     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
064     */
065    public abstract class DynAnySeqHelper
066    {
067      public static TypeCode type()
068      {
069        ORB orb = OrbRestricted.Singleton;
070        TypeCode t = orb.create_sequence_tc(0, DynAnyHelper.type());
071        return orb.create_alias_tc(id(), "DynAnySeq", t);
072      }
073    
074      /**
075       * Insert the DynAnySeq into the given Any.
076       * This method uses the DynAnySeqHolder.
077       *
078       * @param any the Any to insert into.
079       * @param those the DynAny[] to insert.
080       */
081      public static void insert(Any any, DynAny[] those)
082      {
083        any.insert_Streamable(new DynAnySeqHolder(those));
084      }
085    
086      /**
087       * Extract the DynAnySeq from given Any.
088       * This method uses the DynAnySeqHolder.
089       *
090       * @throws BAD_OPERATION if the passed Any does not contain DynAnySeq.
091       */
092      public static DynAny[] extract(Any any)
093      {
094        try
095          {
096            return ((DynAnySeqHolder) any.extract_Streamable()).value;
097          }
098        catch (ClassCastException cex)
099          {
100            BAD_OPERATION bad = new BAD_OPERATION("DynAnySeq expected");
101            bad.initCause(cex);
102            bad.minor = Minor.Any;        
103            throw bad;
104          }
105      }
106    
107      /**
108       * Get the DynAnySeq repository id.
109       *
110       * @return "IDL:omg.org/DynamicAny/DynAnySeq:1.0", always.
111       */
112      public static String id()
113      {
114        return "IDL:omg.org/DynamicAny/DynAnySeq:1.0";
115      }
116    
117      /**
118       * The method should read this object from the CDR input stream, but
119       * (following the JDK 1.5 API) it does not.
120       *
121       * @param input a org.omg.CORBA.portable stream to read from.
122       *
123       * @specenote Sun throws the same exception.
124       *
125       * @throws MARSHAL always.
126       */
127      public static DynAny[] read(InputStream input)
128      {
129        throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
130      }
131    
132      /**
133       * The method should write this object to the CDR input stream, but
134       * (following the JDK 1.5 API) it does not.
135       *
136       * @param output a org.omg.CORBA.portable stream to write into.
137       *
138       * @specenote Sun throws the same exception.
139       *
140       * @throws MARSHAL always.
141       */
142      public static void write(OutputStream output, DynAny[] value)
143      {
144        throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
145      }
146    }