Source for org.omg.PortableInterceptor.ObjectReferenceTemplateSeqHelper

   1: /*  ObjectReferenceTemplateSeqHelper.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: package org.omg.PortableInterceptor;
  39: 
  40: import gnu.CORBA.Minor;
  41: import gnu.CORBA.typecodes.GeneralTypeCode;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.TCKind;
  46: import org.omg.CORBA.TypeCode;
  47: import org.omg.CORBA.portable.InputStream;
  48: import org.omg.CORBA.portable.OutputStream;
  49: import org.omg.CORBA.portable.Streamable;
  50: 
  51: /**
  52:  * Provides static helper methods for working with the array of object reference
  53:  * templates.
  54:  * 
  55:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  56:  */
  57: public abstract class ObjectReferenceTemplateSeqHelper
  58: {
  59:   /**
  60:    * The type code, computed once.
  61:    */
  62:   static TypeCode typecode;
  63: 
  64:   /**
  65:    * Extract the <code>ObjectReferenceTemplate[]</code> from the given
  66:    * {@link Any}. This implementation expects the {@link Any} to hold the
  67:    * instance of {@link ObjectReferenceTemplateSeqHolder} that is returned by
  68:    * {@link Any#extract_Streamable() }.
  69:    * 
  70:    * @param a an Any to extract the array from.
  71:    * 
  72:    * @return the extracted array.
  73:    * 
  74:    * @throws BAD_OPERATION if the Any contains something other than the the
  75:    * {@link ObjectReferenceTemplateSeqHolder}.
  76:    */
  77:   public static ObjectReferenceTemplate[] extract(Any a)
  78:   {
  79:     try
  80:       {
  81:         ObjectReferenceTemplateSeqHolder h = (ObjectReferenceTemplateSeqHolder) 
  82:           a.extract_Streamable();
  83:         return h.value;
  84:       }
  85:     catch (ClassCastException cex)
  86:       {
  87:         BAD_OPERATION bad = new BAD_OPERATION(
  88:           "ObjectReferenceTemplate[] expected");
  89:         bad.initCause(cex);
  90:         bad.minor = Minor.Any;
  91:         throw bad;
  92:       }
  93:   }
  94: 
  95:   /**
  96:    * Returns the object reference template sequence repository Id.
  97:    * 
  98:    * @return "IDL:omg.org/PortableInterceptor/ObjectReferenceTemplateSeq:1.0",
  99:    * always.
 100:    */
 101:   public static String id()
 102:   {
 103:     return "IDL:omg.org/PortableInterceptor/ObjectReferenceTemplateSeq:1.0";
 104:   }
 105: 
 106:   /**
 107:    * Insert into the given <code>ObjectReferenceTemplate[]</code> into the
 108:    * given {@link Any}. This implementation first creates a
 109:    * {@link ObjectReferenceTemplateSeqHolder} and then calls
 110:    * {@link Any#insert_Streamable(Streamable)}.
 111:    * 
 112:    * @param into the target Any.
 113:    * @param that the array to insert.
 114:    */
 115:   public static void insert(Any into, ObjectReferenceTemplate[] that)
 116:   {
 117:     ObjectReferenceTemplateSeqHolder holder = 
 118:       new ObjectReferenceTemplateSeqHolder(that);
 119:     into.insert_Streamable(holder);
 120:   }
 121: 
 122:   /**
 123:    * Reads the <code>ObjectReferenceTemplate[]</code> from the CORBA input
 124:    * stream.
 125:    * 
 126:    * @param input the CORBA (not java.io) stream to read from.
 127:    * @return the value from the stream.
 128:    */
 129:   public static ObjectReferenceTemplate[] read(InputStream input)
 130:   {
 131:     ObjectReferenceTemplate[] value = 
 132:       new ObjectReferenceTemplate[input.read_long()];
 133:     for (int i = 0; i < value.length; i++)
 134:       value[i] = ObjectReferenceTemplateHelper.read(input);
 135:     return value;
 136:   }
 137: 
 138:   /**
 139:    * Creates and returns a new instance of the TypeCode, corresponding the CORBA
 140:    * <code>ObjectReferenceTemplate[]</code>. The length of the sequence is
 141:    * left with the initial value 0.
 142:    */
 143:   public static TypeCode type()
 144:   {
 145:     if (typecode == null)
 146:       {
 147:         GeneralTypeCode t = new GeneralTypeCode(TCKind.tk_sequence);
 148:         t.setId(id());
 149:         t.setLength(0);
 150:         t.setContentType(ObjectReferenceTemplateHelper.type());
 151:         typecode = t;
 152:       }
 153:     return typecode;
 154:   }
 155: 
 156:   /**
 157:    * Writes the <code>ObjectReferenceTemplate[]</code> into the given stream.
 158:    * 
 159:    * @param output the CORBA (not java.io) output stream to write.
 160:    * @param value the value that must be written.
 161:    */
 162:   public static void write(OutputStream output, ObjectReferenceTemplate[] value)
 163:   {
 164:     output.write_long(value.length);
 165: 
 166:     for (int i = 0; i < value.length; i++)
 167:       ObjectReferenceTemplateHelper.write(output, value[i]);
 168:   }
 169: }