001 /* CompletionStatus.java --
002 Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package org.omg.CORBA;
040
041 import gnu.CORBA.Minor;
042
043 import java.io.Serializable;
044
045 import org.omg.CORBA.portable.IDLEntity;
046
047 /**
048 * Defines the method completion status, usually for the time moment,
049 * when the exception has been thrown.
050 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
051 */
052 public final class CompletionStatus
053 implements Serializable, IDLEntity
054 {
055 /**
056 * Use serialVersionUID for interoperability.
057 * Using the version 1.4 UID.
058 */
059 private static final long serialVersionUID = -9047319660881406859L;
060
061 /**
062 * The method was completed when the exception was thrown.
063 */
064 public static final int _COMPLETED_YES = 0;
065
066 /**
067 * The method was running when the exception was thrown.
068 */
069 public static final int _COMPLETED_NO = 1;
070
071 /**
072 * The method was either running or complete (no exact information availabe)
073 * when the exception was thrown.
074 */
075 public static final int _COMPLETED_MAYBE = 2;
076
077 /**
078 * An instance of CompletionStatus, initialized to {@link #COMPLETED_YES }
079 */
080 public static final CompletionStatus COMPLETED_YES =
081 new CompletionStatus(_COMPLETED_YES);
082
083 /**
084 * An instance of CompletionStatus, initialized to {@link #COMPLETED_NO }
085 */
086 public static final CompletionStatus COMPLETED_NO =
087 new CompletionStatus(_COMPLETED_NO);
088
089 /**
090 * An instance of CompletionStatus, initialized to {@link #COMPLETED_MAYBE }
091 */
092 public static final CompletionStatus COMPLETED_MAYBE =
093 new CompletionStatus(_COMPLETED_MAYBE);
094
095 /**
096 * The private array of all states. As long as the states form the uniform
097 * sequence, from_int can find the needed value directly indexing this array.
098 */
099 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 }