org.omg.CORBA
Class CompletionStatus

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by org.omg.CORBA.CompletionStatus
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , IDLEntity sample code for org.omg.CORBA.portable.IDLEntity definition code for org.omg.CORBA.portable.IDLEntity

public final class CompletionStatus
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements IDLEntity sample code for org.omg.CORBA.portable.IDLEntity definition code for org.omg.CORBA.portable.IDLEntity

An object that indicates whether a method had completed running when a SystemException was thrown.

The class CompletionStatus contains three CompletionStatus instances, which are constants representing each possible completion status: COMPLETED_MAYBE, COMPLETED_NO, and COMPLETED_YES. It also contains three int members, each a constant corresponding to one of the CompletionStatus instances. These int members make it possible to use a switch statement.

The class also contains two methods:

Since:
JDK1.2
See Also:
SystemException sample code for org.omg.CORBA.SystemException definition code for org.omg.CORBA.SystemException , Serialized Form

Field Summary
static int _COMPLETED_MAYBE
          The constant indicating that a method completed running before a SystemException was thrown.
static int _COMPLETED_NO
          The constant indicating that a method completed running before a SystemException was thrown.
static int _COMPLETED_YES
          The constant indicating that a method completed running before a SystemException was thrown.
static CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus COMPLETED_MAYBE sample code for org.omg.CORBA.CompletionStatus.COMPLETED_MAYBE definition code for org.omg.CORBA.CompletionStatus.COMPLETED_MAYBE
          An instance of CompletionStatus initialized with the constant _COMPLETED_MAYBE.
static CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus COMPLETED_NO sample code for org.omg.CORBA.CompletionStatus.COMPLETED_NO definition code for org.omg.CORBA.CompletionStatus.COMPLETED_NO
          An instance of CompletionStatus initialized with the constant _COMPLETED_NO.
static CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus COMPLETED_YES sample code for org.omg.CORBA.CompletionStatus.COMPLETED_YES definition code for org.omg.CORBA.CompletionStatus.COMPLETED_YES
          An instance of CompletionStatus initialized with the constant _COMPLETED_YES.
 
Method Summary
static CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus from_int sample code for org.omg.CORBA.CompletionStatus.from_int(int) definition code for org.omg.CORBA.CompletionStatus.from_int(int) (int i)
          Creates a CompletionStatus object from the given int.
 int value sample code for org.omg.CORBA.CompletionStatus.value() definition code for org.omg.CORBA.CompletionStatus.value() ()
          Retrieves the value of this CompletionStatus object.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

_COMPLETED_YES sample code for org.omg.CORBA.CompletionStatus._COMPLETED_YES

public static final int _COMPLETED_YES
The constant indicating that a method completed running before a SystemException was thrown.

See Also:
Constant Field Values

_COMPLETED_NO sample code for org.omg.CORBA.CompletionStatus._COMPLETED_NO

public static final int _COMPLETED_NO
The constant indicating that a method completed running before a SystemException was thrown.

See Also:
Constant Field Values

_COMPLETED_MAYBE sample code for org.omg.CORBA.CompletionStatus._COMPLETED_MAYBE

public static final int _COMPLETED_MAYBE
The constant indicating that a method completed running before a SystemException was thrown.

See Also:
Constant Field Values

COMPLETED_YES sample code for org.omg.CORBA.CompletionStatus.COMPLETED_YES

public static final CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus  COMPLETED_YES
An instance of CompletionStatus initialized with the constant _COMPLETED_YES.


COMPLETED_NO sample code for org.omg.CORBA.CompletionStatus.COMPLETED_NO

public static final CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus  COMPLETED_NO
An instance of CompletionStatus initialized with the constant _COMPLETED_NO.


COMPLETED_MAYBE sample code for org.omg.CORBA.CompletionStatus.COMPLETED_MAYBE

public static final CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus  COMPLETED_MAYBE
An instance of CompletionStatus initialized with the constant _COMPLETED_MAYBE.

Method Detail

value sample code for org.omg.CORBA.CompletionStatus.value() definition code for org.omg.CORBA.CompletionStatus.value()

public int value()
Retrieves the value of this CompletionStatus object.

Returns:
one of the possible CompletionStatus values: _COMPLETED_YES, _COMPLETED_NO, or _COMPLETED_MAYBE

from_int sample code for org.omg.CORBA.CompletionStatus.from_int(int) definition code for org.omg.CORBA.CompletionStatus.from_int(int)

public static CompletionStatus sample code for org.omg.CORBA.CompletionStatus definition code for org.omg.CORBA.CompletionStatus  from_int(int i)
Creates a CompletionStatus object from the given int.

Parameters:
i - one of _COMPLETED_YES, _COMPLETED_NO, or _COMPLETED_MAYBE
Returns:
one of the possible CompletionStatus objects with values: _COMPLETED_YES, _COMPLETED_NO, or _COMPLETED_MAYBE
Throws:
BAD_PARAM sample code for org.omg.CORBA.BAD_PARAM definition code for org.omg.CORBA.BAD_PARAM - if the argument given is not one of the int constants defined in CompletionStatus