Source for org.omg.CORBA.CompletionStatus

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