001/* CompletionStatusHelper.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import gnu.CORBA.OrbRestricted;
042
043import org.omg.CORBA.portable.InputStream;
044import org.omg.CORBA.portable.OutputStream;
045
046/**
047 * Provides static helper methods for working with
048 * {@link CompletionStatus}.
049 *
050 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
051 */
052public abstract class CompletionStatusHelper
053{
054  /**
055   * Extract the {@link CompletionStatus} from the
056   * given {@link Any}. This implementation expects
057   * the integer (Corba long) value, stating the completion
058   * status.
059   *
060   * @param a an Any to extract the completion status from.
061   *
062   * @return completion status
063   */
064  public static CompletionStatus extract(Any a)
065  {
066    return CompletionStatus.from_int(a.extract_long());
067  }
068
069  /**
070   * Returns the agreed Id.
071   * @return <code>IDL:omg.org/CORBA/CompletionStatus:1.0</code>, always.
072   */
073  public static String id()
074  {
075    return "IDL:omg.org/CORBA/CompletionStatus:1.0";
076  }
077
078  /**
079  * Insert into the given {@link CompletionStatus} into the
080  * given {@link Any}. This implementation inserts it as an
081  * integer (CORBA long).
082  *
083  * @param into the target Any.
084  * @param that the {@link CompletionStatus} to insert.
085  */
086  public static void insert(Any into, CompletionStatus that)
087  {
088    into.insert_long(that.value());
089  }
090
091  /**
092   * Reads the {@link CompletionStatus} from the CORBA input stream.
093   * This implementation reads an an integer (CORBA long).
094   *
095   * @param input the CORBA (not java.io) stream to read from.
096   * @return the value from the stream.
097   */
098  public static CompletionStatus read(InputStream input)
099  {
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}