Source for org.omg.CORBA.CompletionStatusHelper

   1: /* CompletionStatusHelper.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.CORBA;
  40: 
  41: import gnu.CORBA.OrbRestricted;
  42: 
  43: import org.omg.CORBA.portable.InputStream;
  44: import org.omg.CORBA.portable.OutputStream;
  45: 
  46: /**
  47:  * Provides static helper methods for working with
  48:  * {@link CompletionStatus}.
  49:  *
  50:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  51:  */
  52: public abstract class CompletionStatusHelper
  53: {
  54:   /**
  55:    * Extract the {@link CompletionStatus} from the
  56:    * given {@link Any}. This implementation expects
  57:    * the integer (Corba long) value, stating the completion
  58:    * status.
  59:    *
  60:    * @param a an Any to extract the completion status from.
  61:    *
  62:    * @return completion status
  63:    */
  64:   public static CompletionStatus extract(Any a)
  65:   {
  66:     return CompletionStatus.from_int(a.extract_long());
  67:   }
  68: 
  69:   /**
  70:    * Returns the agreed Id.
  71:    * @return <code>IDL:omg.org/CORBA/CompletionStatus:1.0</code>, always.
  72:    */
  73:   public static String id()
  74:   {
  75:     return "IDL:omg.org/CORBA/CompletionStatus:1.0";
  76:   }
  77: 
  78:   /**
  79:   * Insert into the given {@link CompletionStatus} into the
  80:   * given {@link Any}. This implementation inserts it as an
  81:   * integer (CORBA long).
  82:   *
  83:   * @param into the target Any.
  84:   * @param that the {@link CompletionStatus} to insert.
  85:   */
  86:   public static void insert(Any into, CompletionStatus that)
  87:   {
  88:     into.insert_long(that.value());
  89:   }
  90: 
  91:   /**
  92:    * Reads the {@link CompletionStatus} from the CORBA input stream.
  93:    * This implementation reads an an integer (CORBA long).
  94:    *
  95:    * @param input the CORBA (not java.io) stream to read from.
  96:    * @return the value from the stream.
  97:    */
  98:   public static CompletionStatus read(InputStream input)
  99:   {
 100:     return CompletionStatus.from_int(input.read_long());
 101:   }
 102: 
 103:   /**
 104:    * Writes the {@link CompletionStatus} into the given stream.
 105:    * This implementation writes an int (CORBA long), corresponding
 106:    * the status of completion.
 107:    *
 108:    * @param output the CORBA (not java.io) output stream to write.
 109:    * @param status the value that must be written.
 110:    */
 111:   public static void write(OutputStream output, CompletionStatus status)
 112:   {
 113:     output.write_long(status.value());
 114:   }
 115: 
 116:   /**
 117:    * Get the parameter mode typecode (enumeration, named "CompletionStatus").
 118:    * The typecode states that the enumeration can obtain one of
 119:    * the following values:  COMPLETED_YES ,COMPLETED_NO or COMPLETED_MAYBE .
 120:    */
 121:   public static TypeCode type()
 122:   {
 123:     String[] members =
 124:       new String[] { "COMPLETED_YES", "COMPLETED_NO", "COMPLETED_MAYBE" };
 125: 
 126:     return
 127:       OrbRestricted.Singleton.create_enum_tc(id(), "CompletionStatus",
 128:                                              members
 129:       );
 130:   }
 131: }