CompletionStatus JDK 1.6)

Description

publicfinal class CompletionStatus

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:

public int value() -- which accesses the value field of a CompletionStatus object
public static CompletionStatus from_int(int i) -- for creating an instance from one of the int members

See also: SystemException

Constructors

private CompletionStatus (int _value)

Creates a CompletionStatus object from the given int.

Creates a CompletionStatus object from the given int.
Parameters:
- _value - one of _COMPLETED_YES, _COMPLETED_NO, or _COMPLETED_MAYBE

Methods

Hide/Show inherited methods

publicstatic CompletionStatus from_int (int i)

Creates a CompletionStatus object from the given int.

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

public int value ()

Retrieves the value of this CompletionStatus object.

Retrieves the value of this CompletionStatus object.
Returns: one of the possible CompletionStatus values: _COMPLETED_YES, _COMPLETED_NO, or _COMPLETED_MAYBE

Fields

Hide/Show inherited fields

publicfinalstatic int _COMPLETED_MAYBE = "2"

The constant indicating that a method completed running before a SystemException was thrown.

publicfinalstatic int _COMPLETED_NO = "1"

The constant indicating that a method completed running before a SystemException was thrown.

publicfinalstatic int _COMPLETED_YES = "0"

The constant indicating that a method completed running before a SystemException was thrown.

publicfinalstatic CompletionStatus COMPLETED_MAYBE

An instance of CompletionStatus initialized with the constant _COMPLETED_MAYBE.

publicfinalstatic CompletionStatus COMPLETED_NO

An instance of CompletionStatus initialized with the constant _COMPLETED_NO.

publicfinalstatic CompletionStatus COMPLETED_YES

An instance of CompletionStatus initialized with the constant _COMPLETED_YES.