gomp-20050608-branch/libjava/classpath/org/omg/CORBA/CompletionStatus.java

   1 /* CompletionStatus.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.Minor;
  42
  43 import java.io.Serializable;
  44
  45 import org.omg.CORBA.portable.IDLEntity;
  46
  47 /**
  48  * Defines the method completion status, usually for the time moment,
  49  * when the exception has been thrown.
  50  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  51  */
  52 public class CompletionStatus
  53   implements Serializable, IDLEntity
  54 {
  55   /**
  56    * Use serialVersionUID for interoperability.
  57    * Using the version 1.4 UID.
  58    */
  59   private static final long serialVersionUID = -9047319660881406859L;
  60
  61   /**
  62    * The method was completed when the exception was thrown.
  63    */
  64   public static final int _COMPLETED_YES = 0;
  65
  66   /**
  67    * The method was running when the exception was thrown.
  68    */
  69   public static final int _COMPLETED_NO = 1;
  70
  71   /**
  72    * The method was either running or complete (no exact information availabe)
  73    * when the exception was thrown.
  74    */
  75   public static final int _COMPLETED_MAYBE = 2;
  76
  77   /**
  78    * An instance of CompletionStatus, initialized to {@link #COMPLETED_YES }
  79    */
  80   public static final CompletionStatus COMPLETED_YES =
  81     new CompletionStatus(_COMPLETED_YES);
  82
  83   /**
  84    * An instance of CompletionStatus, initialized to {@link #COMPLETED_NO }
  85    */
  86   public static final CompletionStatus COMPLETED_NO =
  87     new CompletionStatus(_COMPLETED_NO);
  88
  89   /**
  90    * An instance of CompletionStatus, initialized to {@link #COMPLETED_MAYBE }
  91    */
  92   public static final CompletionStatus COMPLETED_MAYBE =
  93     new CompletionStatus(_COMPLETED_MAYBE);
  94
  95   /**
  96    * The private array of all states. As long as the states form the uniform
  97    * sequence, from_int can find the needed value directly indexing this array.
  98    */
  99   private static final CompletionStatus[] states =
 100     new CompletionStatus[] { COMPLETED_YES, COMPLETED_NO, COMPLETED_MAYBE };
 101   private final int _value;
 102
 103   /**
 104    * No other instances can be created.
 105    */
 106   private CompletionStatus(int a_value)
 107   {
 108     _value = a_value;
 109   }
 110
 111   /**
 112    * Returns the CompletionStatus, matching the given integer constant
 113    *
 114    * @param completion one of COMPLETED_YES, COMPLETED_NO or COMPLEED_MAYBE.
 115    * @return one of COMPLETED_YES, COMPLETED_NO or COMPLEED_MAYBE.
 116    * @throws BAD_PARAM if the parameter is not one of these three valid values.
 117    */
 118   public static CompletionStatus from_int(int completion)
 119   {
 120     try
 121       {
 122         return states[completion];
 123       }
 124     catch (ArrayIndexOutOfBoundsException ex)
 125       {
 126         BAD_OPERATION bad = new BAD_OPERATION("Invalid completion status "
 127           + completion);
 128         bad.minor = Minor.Enumeration;
 129         throw bad;
 130       }
 131   }
 132
 133   /**
 134    * Returns a short string representation.
 135    * @return a string, defining the completion status.
 136    */
 137   public String toString()
 138   {
 139     switch (value())
 140       {
 141         case _COMPLETED_YES :
 142           return "completed";
 143
 144         case _COMPLETED_NO :
 145           return "not completed";
 146
 147         case _COMPLETED_MAYBE :
 148           return "maybe completed";
 149
 150         default :
 151           return "invalid completion status instance";
 152       }
 153   }
 154
 155   /**
 156    * Returns the value, representing the completion
 157    * status of this object.
 158    * @return one of COMPLETED_MAYBE, COMPLETED_YES or COMPLETED_NO
 159    */
 160   public int value()
 161   {
 162     return _value;
 163   }
 164 }