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