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: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.BAD_PARAM;
  46: import org.omg.CORBA.ORB;
  47: import org.omg.CORBA.TypeCode;
  48: import org.omg.CORBA.portable.Delegate;
  49: import org.omg.CORBA.portable.InputStream;
  50: import org.omg.CORBA.portable.ObjectImpl;
  51: import org.omg.CORBA.portable.OutputStream;
  52: 
  53: /**
  54:  * The helper operations for {@link BindingIterator}
  55:  *
  56:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57:  */
  58: public abstract class BindingIteratorHelper
  59: {
  60:   /**
  61:    * The {@link BindingIterator} repository id.
  62:    */
  63:   private static String _id = "IDL:omg.org/CosNaming/BindingIterator:1.0";
  64: 
  65:   /**
  66:    * The cached type code value.
  67:    */
  68:   private static TypeCode typeCode = null;
  69: 
  70:   /**
  71:    * Extract the binding iterator from the given {@link Any}.
  72:    */
  73:   public static BindingIterator extract(Any a)
  74:   {
  75:     try
  76:       {
  77:         return ((BindingIteratorHolder) a.extract_Streamable()).value;
  78:       }
  79:     catch (ClassCastException ex)
  80:       {
  81:         BAD_OPERATION bad = new BAD_OPERATION("Binding iterator expected");
  82:         bad.initCause(ex);
  83:         bad.minor = Minor.Any;
  84:         throw bad;
  85:       }
  86:   }
  87: 
  88:   /**
  89:    * Return the binding iterator repository id.
  90:    */
  91:   public static String id()
  92:   {
  93:     return _id;
  94:   }
  95: 
  96:   /**
  97:    * Insert the binding iterator into the given {@link Any}.
  98:    */
  99:   public static void insert(Any a, BindingIterator that)
 100:   {
 101:     a.insert_Streamable(new BindingIteratorHolder(that));
 102:   }
 103: 
 104:   /**
 105:    * Narrow the given object to the BindingIterator. The narrowing
 106:    * means either direct casting or re-instantiating with the same
 107:    * delegate.
 108:    *
 109:    * @param obj the object to cast.
 110:    *
 111:    * @return the casted binding iterator.
 112:    */
 113:   public static BindingIterator narrow(org.omg.CORBA.Object obj)
 114:   {
 115:     if (obj == null)
 116:       return null;
 117:     else if (obj instanceof BindingIterator)
 118:       return (BindingIterator) obj;
 119:     else if (!obj._is_a(id()))
 120:       throw new BAD_PARAM();
 121:     else
 122:       {
 123:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 124:         return new _BindingIteratorStub(delegate);
 125:       }
 126:   }
 127:   
 128:   /**
 129:    * Narrow the given object to the BindingIterator. No type-checking is
 130:    * performed to verify that the object actually supports the requested type.
 131:    * The {@link BAD_OPERATION} will be thrown if unsupported operations are
 132:    * invoked on the new returned reference, but no failure is expected at the
 133:    * time of the unchecked_narrow.
 134:    * 
 135:    * @param obj the object to cast.
 136:    * 
 137:    * @return the casted binding iterator.
 138:    * 
 139:    * @since 1.5 
 140:    * 
 141:    * @see OMG issue 4158.
 142:    */
 143:   public static BindingIterator unchecked_narrow(org.omg.CORBA.Object obj)
 144:   {
 145:     if (obj == null)
 146:       return null;
 147:     else if (obj instanceof BindingIterator)
 148:       return (BindingIterator) obj;
 149:     else
 150:       {
 151:         // Do not call the _is_a(..).
 152:         Delegate delegate = ((ObjectImpl) obj)._get_delegate();
 153:         return new _BindingIteratorStub(delegate);
 154:       }    
 155:   }
 156: 
 157:   /**
 158:    * Read the exception from the given CDR stream.
 159:    */
 160:   public static BindingIterator read(InputStream istream)
 161:   {
 162:     return narrow(istream.read_Object(_BindingIteratorStub.class));
 163:   }
 164: 
 165:   /**
 166:    * Create the type code for the BindingIterator.
 167:    */
 168:   public static TypeCode type()
 169:   {
 170:     if (typeCode == null)
 171:       typeCode = ORB.init().create_interface_tc(id(), "BindingIterator");
 172:     return typeCode;
 173:   }
 174: 
 175:   /**
 176:    * Write the exception to the CDR output stream.
 177:    */
 178:   public static void write(OutputStream ostream, BindingIterator value)
 179:   {
 180:     ostream.write_Object((org.omg.CORBA.Object) value);
 181:   }
 182: }