Class CompletionStatus

public final class CompletionStatus
extends Object
implements 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:

• 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

Fields

_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

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

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

public static final CompletionStatus COMPLETED_YES

An instance of CompletionStatus initialized with the constant _COMPLETED_YES.

COMPLETED_NO

public static final CompletionStatus COMPLETED_NO

An instance of CompletionStatus initialized with the constant _COMPLETED_NO.

COMPLETED_MAYBE

public static final CompletionStatus COMPLETED_MAYBE

An instance of CompletionStatus initialized with the constant _COMPLETED_MAYBE.

Methods

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

public static 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 - if the argument given is not one of the int constants defined in CompletionStatus