Source for org.omg.CosNaming.BindingIteratorHelper

   1: /* BindingIteratorHelper.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.CosNaming;
  40: 
  41: import gnu.CORBA.Minor;
  42: import gnu.CORBA.OrbRestricted;
  43: 
  44: import org.omg.CORBA.Any;
  45: import org.omg.CORBA.BAD_OPERATION;
  46: import org.omg.CORBA.BAD_PARAM;
  47: import org.omg.CORBA.ORB;
  48: import org.omg.CORBA.TypeCode;
  49: import org.omg.CORBA.portable.Delegate;
  50: import org.omg.CORBA.portable.InputStream;
  51: import org.omg.CORBA.portable.ObjectImpl;
  52: import org.omg.CORBA.portable.OutputStream;
  53: 
  54: /**
  55:  * The helper operations for {@link BindingIterator}
  56:  *
  57:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  58:  */
  59: public abstract class BindingIteratorHelper
  60: {
  61:   /**
  62:    * The {@link BindingIterator} repository id.
  63:    */
  64:   private static String _id = "IDL:omg.org/CosNaming/BindingIterator:1.0";
  65: 
  66:   /**
  67:    * Extract the binding iterator from the given {@link Any}.
  68:    */
  69:   public static BindingIterator extract(Any a)
  70:   {
  71:     try
  72:       {
  73:         return ((BindingIteratorHolder) a.extract_Streamable()).value;
  74:       }
  75:     catch (ClassCastException ex)
  76:       {
  77:         BAD_OPERATION bad = new BAD_OPERATION("Binding iterator expected");
  78:         bad.initCause(ex);
  79:         bad.minor = Minor.Any;
  80:         throw bad;
  81:       }
  82:   }
  83: 
  84:   /**
  85:    * Return the binding iterator repository id.
  86:    */
  87:   public static String id()
  88:   {
  89:     return _id;
  90:   }
  91: 
  92:   /**
  93:    * Insert the binding iterator into the given {@link Any}.
  94:    */
  95:   public static void insert(Any a, BindingIterator that)
  96:   {
  97:     a.insert_Streamable(new BindingIteratorHolder(that));
  98:   }
  99: 
 100:   /**
 101:    * Narrow the given object to the BindingIterator. The narrowing
 102:    * means either direct casting or re-instantiating with the same
 103:    * delegate.
 104:    *
 105:    * @param obj the object to cast.
 106:    *
 107:    * @return the casted binding iterator.
 108:    */
 109:   public static BindingIterator narrow(org.omg.CORBA.Object obj)
 110:   {
 111:     if (obj == null)
 112:       return null;
 113:     else if (obj instanceof BindingIterator)
 114:       return (BindingIterator) obj;
 115:     else if (!obj._is_a(id()))
 116:       throw new BAD_PARAM();
 117:     else
 118:       {
 119:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 120:         return new _BindingIteratorStub(delegate);
 121:       }
 122:   }
 123:   
 124:   /**
 125:    * Narrow the given object to the BindingIterator. No type-checking is
 126:    * performed to verify that the object actually supports the requested type.
 127:    * The {@link BAD_OPERATION} will be thrown if unsupported operations are
 128:    * invoked on the new returned reference, but no failure is expected at the
 129:    * time of the unchecked_narrow.
 130:    * 
 131:    * @param obj the object to cast.
 132:    * 
 133:    * @return the casted binding iterator.
 134:    * 
 135:    * @since 1.5 
 136:    * 
 137:    * @see OMG issue 4158.
 138:    */
 139:   public static BindingIterator unchecked_narrow(org.omg.CORBA.Object obj)
 140:   {
 141:     if (obj == null)
 142:       return null;
 143:     else if (obj instanceof BindingIterator)
 144:       return (BindingIterator) obj;
 145:     else
 146:       {
 147:         // Do not call the _is_a(..).
 148:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 149:         return new _BindingIteratorStub(delegate);
 150:       }    
 151:   }
 152: 
 153:   /**
 154:    * Read the exception from the given CDR stream.
 155:    */
 156:   public static BindingIterator read(InputStream istream)
 157:   {
 158:     return narrow(istream.read_Object(_BindingIteratorStub.class));
 159:   }
 160: 
 161:   /**
 162:    * Create the type code for the BindingIterator.
 163:    */
 164:   public static TypeCode type()
 165:   {
 166:     return OrbRestricted.Singleton.create_interface_tc(id(), "BindingIterator");
 167:   }
 168: 
 169:   /**
 170:    * Write the exception to the CDR output stream.
 171:    */
 172:   public static void write(OutputStream ostream, BindingIterator value)
 173:   {
 174:     ostream.write_Object((org.omg.CORBA.Object) value);
 175:   }
 176: }