Source for org.omg.DynamicAny.DynAnySeqHelper

   1: /* DynAnySeq.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.DynamicAny;
  40: 
  41: import gnu.CORBA.DynAnySeqHolder;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.MARSHAL;
  46: import org.omg.CORBA.ORB;
  47: import org.omg.CORBA.TypeCode;
  48: import org.omg.CORBA.portable.InputStream;
  49: import org.omg.CORBA.portable.OutputStream;
  50: 
  51: /**
  52:  * A helper operations for the array of {@link DynAny} ({@link DynAnySeq}).
  53:  * Following the 1.5 JDK specifications, DynAny (and hence an sequence of
  54:  * DynAny's) is always a local object, so the two methods of this helper
  55:  * ({@link #read} and {@link #write} are not in use, always throwing
  56:  * {@link MARSHAL}.
  57:  *
  58:  * @specnote always throwing MARSHAL in read and write ensures compatibility
  59:  * with other popular implementations like Sun's.
  60:  *
  61:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  62:  */
  63: public abstract class DynAnySeqHelper
  64: {
  65:   /**
  66:    * The cached typecode value, computed only once.
  67:    */
  68:   private static TypeCode typeCode;
  69: 
  70:   public static TypeCode type()
  71:   {
  72:     if (typeCode == null)
  73:       {
  74:         ORB orb = ORB.init();
  75:         TypeCode t = orb.create_sequence_tc(0, DynAnyHelper.type());
  76:         typeCode = orb.create_alias_tc(id(), "DynAnySeq", t);
  77:       }
  78:     return typeCode;
  79:   }
  80: 
  81:   /**
  82:    * Insert the DynAnySeq into the given Any.
  83:    * This method uses the DynAnySeqHolder.
  84:    *
  85:    * @param any the Any to insert into.
  86:    * @param those the DynAny[] to insert.
  87:    */
  88:   public static void insert(Any any, DynAny[] those)
  89:   {
  90:     any.insert_Streamable(new DynAnySeqHolder(those));
  91:   }
  92: 
  93:   /**
  94:    * Extract the DynAnySeq from given Any.
  95:    * This method uses the DynAnySeqHolder.
  96:    *
  97:    * @throws BAD_OPERATION if the passed Any does not contain DynAnySeq.
  98:    */
  99:   public static DynAny[] extract(Any any)
 100:   {
 101:     try
 102:       {
 103:         return ((DynAnySeqHolder) any.extract_Streamable()).value;
 104:       }
 105:     catch (ClassCastException cex)
 106:       {
 107:         BAD_OPERATION bad = new BAD_OPERATION("DynAnySeq expected");
 108:         bad.initCause(cex);
 109:         throw bad;
 110:       }
 111:   }
 112: 
 113:   /**
 114:    * Get the DynAnySeq repository id.
 115:    *
 116:    * @return "IDL:omg.org/DynamicAny/DynAnySeq:1.0", always.
 117:    */
 118:   public static String id()
 119:   {
 120:     return "IDL:omg.org/DynamicAny/DynAnySeq:1.0";
 121:   }
 122: 
 123:   /**
 124:    * The method should read this object from the CDR input stream, but
 125:    * (following the JDK 1.5 API) it does not.
 126:    *
 127:    * @param input a org.omg.CORBA.portable stream to read from.
 128:    *
 129:    * @specenote Sun throws the same exception.
 130:    *
 131:    * @throws MARSHAL always.
 132:    */
 133:   public static DynAny[] read(InputStream input)
 134:   {
 135:     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 136:   }
 137: 
 138:   /**
 139:    * The method should write this object to the CDR input stream, but
 140:    * (following the JDK 1.5 API) it does not.
 141:    *
 142:    * @param input a org.omg.CORBA.portable stream to read from.
 143:    *
 144:    * @specenote Sun throws the same exception.
 145:    *
 146:    * @throws MARSHAL always.
 147:    */
 148:   public static void write(OutputStream output, DynAny[] value)
 149:   {
 150:     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 151:   }