001    /* BindingIteratorHelper.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.CosNaming;
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.BAD_PARAM;
047    import org.omg.CORBA.TypeCode;
048    import org.omg.CORBA.portable.Delegate;
049    import org.omg.CORBA.portable.InputStream;
050    import org.omg.CORBA.portable.ObjectImpl;
051    import org.omg.CORBA.portable.OutputStream;
052    
053    /**
054     * The helper operations for {@link BindingIterator}
055     *
056     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057     */
058    public abstract class BindingIteratorHelper
059    {
060      /**
061       * The {@link BindingIterator} repository id.
062       */
063      private static String _id = "IDL:omg.org/CosNaming/BindingIterator:1.0";
064    
065      /**
066       * Extract the binding iterator from the given {@link Any}.
067       */
068      public static BindingIterator extract(Any a)
069      {
070        try
071          {
072            return ((BindingIteratorHolder) a.extract_Streamable()).value;
073          }
074        catch (ClassCastException ex)
075          {
076            BAD_OPERATION bad = new BAD_OPERATION("Binding iterator expected");
077            bad.initCause(ex);
078            bad.minor = Minor.Any;
079            throw bad;
080          }
081      }
082    
083      /**
084       * Return the binding iterator repository id.
085       */
086      public static String id()
087      {
088        return _id;
089      }
090    
091      /**
092       * Insert the binding iterator into the given {@link Any}.
093       */
094      public static void insert(Any a, BindingIterator that)
095      {
096        a.insert_Streamable(new BindingIteratorHolder(that));
097      }
098    
099      /**
100       * Narrow the given object to the BindingIterator. The narrowing
101       * means either direct casting or re-instantiating with the same
102       * delegate.
103       *
104       * @param obj the object to cast.
105       *
106       * @return the casted binding iterator.
107       */
108      public static BindingIterator narrow(org.omg.CORBA.Object obj)
109      {
110        if (obj == null)
111          return null;
112        else if (obj instanceof BindingIterator)
113          return (BindingIterator) obj;
114        else if (!obj._is_a(id()))
115          throw new BAD_PARAM();
116        else
117          {
118            Delegate delegate = ((ObjectImpl) obj)._get_delegate();
119            return new _BindingIteratorStub(delegate);
120          }
121      }
122      
123      /**
124       * Narrow the given object to the BindingIterator. No type-checking is
125       * performed to verify that the object actually supports the requested type.
126       * The {@link BAD_OPERATION} will be thrown if unsupported operations are
127       * invoked on the new returned reference, but no failure is expected at the
128       * time of the unchecked_narrow. See OMG issue 4158.
129       * 
130       * @param obj the object to cast.
131       * 
132       * @return the casted binding iterator.
133       * 
134       * @since 1.5 
135       */
136      public static BindingIterator unchecked_narrow(org.omg.CORBA.Object obj)
137      {
138        if (obj == null)
139          return null;
140        else if (obj instanceof BindingIterator)
141          return (BindingIterator) obj;
142        else
143          {
144            // Do not call the _is_a(..).
145            Delegate delegate = ((ObjectImpl) obj)._get_delegate();
146            return new _BindingIteratorStub(delegate);
147          }    
148      }
149    
150      /**
151       * Read the exception from the given CDR stream.
152       */
153      public static BindingIterator read(InputStream istream)
154      {
155        return narrow(istream.read_Object(_BindingIteratorStub.class));
156      }
157    
158      /**
159       * Create the type code for the BindingIterator.
160       */
161      public static TypeCode type()
162      {
163        return OrbRestricted.Singleton.create_interface_tc(id(), "BindingIterator");
164      }
165    
166      /**
167       * Write the exception to the CDR output stream.
168       */
169      public static void write(OutputStream ostream, BindingIterator value)
170      {
171        ostream.write_Object((org.omg.CORBA.Object) value);
172      }
173    }