Source for org.omg.Messaging.SyncScopeHelper

   1: /* SyncScopeHelper.java --
   2:    Copyright (C) 2005, 2006 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.Messaging;
  40: 
  41: import gnu.CORBA.typecodes.PrimitiveTypeCode;
  42: import gnu.CORBA.typecodes.RecordTypeCode;
  43: 
  44: import org.omg.CORBA.Any;
  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: 
  50: /**
  51:  * A helper operations for synchronization scope as an alias of
  52:  * <code>short</code>.
  53:  *
  54:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  55:  *
  56:  * @see SYNC_WITH_TRANSPORT
  57:  */
  58: public abstract class SyncScopeHelper
  59: {
  60: 
  61:   /**
  62:    * Delegates call to {@link Any#extract_short()}.
  63:    */
  64:   public static short extract(Any a)
  65:   {
  66:     return a.extract_short();
  67:   }
  68: 
  69:   /**
  70:    * Returns synchronization scope repository id.
  71:    *
  72:    * @return "IDL:omg.org/Messaging/SyncScope:1.0", always.
  73:    */
  74:   public static String id()
  75:   {
  76:     return "IDL:omg.org/Messaging/SyncScope:1.0";
  77:   }
  78: 
  79:   /**
  80:    * Delegates call to {@link Any#insert_short(short)}.
  81:    */
  82:   public static void insert(Any a, short that)
  83:   {
  84:     a.insert_short(that);
  85:   }
  86: 
  87:   /**
  88:    * Delegates call to {@link InputStream#read_short()}.
  89:    */
  90:   public static short read(InputStream istream)
  91:   {
  92:     return istream.read_short();
  93:   }
  94: 
  95:   /**
  96:    * Returns a typecode of the synchronization scope, stating it
  97:    * is an alias of <code>short</code>, named "SyncScope".
  98:    *
  99:    * @return a typecode of synchronization scope.
 100:    */
 101:   public static TypeCode type()
 102:   {
 103:     RecordTypeCode r = new RecordTypeCode(TCKind.tk_alias);
 104:     r.setName("SyncScope");
 105:     r.setId(id());
 106:     r.setContentType(new PrimitiveTypeCode(TCKind.tk_short));
 107:     return r;
 108:   }
 109: 
 110:   /**
 111:    * Delegates call to {@link OutputStream#write_short(short)}.
 112:    */
 113:   public static void write(OutputStream ostream, short value)
 114:   {
 115:     ostream.write_short(value);
 116:   }