libjava/classpath/org/omg/CORBA/CompletionStatusHelper.java

   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    * The cached typecode value, computed once.
  56    */
  57   private static TypeCode typeCode;
  58
  59   /**
  60    * Extract the {@link CompletionStatus} from the
  61    * given {@link Any}. This implementation expects
  62    * the integer (Corba long) value, stating the completion
  63    * status.
  64    *
  65    * @param a an Any to extract the completion status from.
  66    *
  67    * @return completion status
  68    */
  69   public static CompletionStatus extract(Any a)
  70   {
  71     return CompletionStatus.from_int(a.extract_long());
  72   }
  73
  74   /**
  75    * Returns the agreed Id.
  76    * @return <code>IDL:omg.org/CORBA/CompletionStatus:1.0</code>, always.
  77    */
  78   public static String id()
  79   {
  80     return "IDL:omg.org/CORBA/CompletionStatus:1.0";
  81   }
  82
  83   /**
  84   * Insert into the given {@link CompletionStatus} into the
  85   * given {@link Any}. This implementation inserts it as an
  86   * integer (CORBA long).
  87   *
  88   * @param into the target Any.
  89   * @param that the {@link CompletionStatus} to insert.
  90   */
  91   public static void insert(Any into, CompletionStatus that)
  92   {
  93     into.insert_long(that.value());
  94   }
  95
  96   /**
  97    * Reads the {@link CompletionStatus} from the CORBA input stream.
  98    * This implementation reads an an integer (CORBA long).
  99    *
 100    * @param input the CORBA (not java.io) stream to read from.
 101    * @return the value from the stream.
 102    */
 103   public static CompletionStatus read(InputStream input)
 104   {
 105     return CompletionStatus.from_int(input.read_long());
 106   }
 107
 108   /**
 109    * Writes the {@link CompletionStatus} into the given stream.
 110    * This implementation writes an int (CORBA long), corresponding
 111    * the status of completion.
 112    *
 113    * @param output the CORBA (not java.io) output stream to write.
 114    * @param status the value that must be written.
 115    */
 116   public static void write(OutputStream output, CompletionStatus status)
 117   {
 118     output.write_long(status.value());
 119   }
 120
 121   /**
 122    * Get the parameter mode typecode (enumeration, named "CompletionStatus").
 123    * The typecode states that the enumeration can obtain one of
 124    * the following values:  COMPLETED_YES ,COMPLETED_NO or COMPLETED_MAYBE .
 125    */
 126   public static TypeCode type()
 127   {
 128     if (typeCode == null)
 129       {
 130         String[] members =
 131           new String[] { "COMPLETED_YES", "COMPLETED_NO", "COMPLETED_MAYBE" };
 132
 133         typeCode =
 134           OrbRestricted.Singleton.create_enum_tc(id(), "CompletionStatus",
 135                                                   members
 136                                                  );
 137       }
 138     return typeCode;
 139   }
 140 }