org.omg.CORBA.CompletionStatus Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
* v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License v2.0
* w/Classpath exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause OR GPL-2.0 WITH
* Classpath-exception-2.0
*/
package org.omg.CORBA;
/**
* 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
*
* @version %I, %G
* @see org.omg.CORBA.SystemException
* @since JDK1.2
*/
// @SuppressWarnings({"serial"})
public final class CompletionStatus implements org.omg.CORBA.portable.IDLEntity
{
/**
* The constant indicating that a method completed running
* before a SystemException was thrown.
*/
public static final int _COMPLETED_YES = 0,
/**
* The constant indicating that a method had not completed running
* when a SystemException was thrown.
*/
_COMPLETED_NO = 1,
/**
* The constant indicating that it is unknown whether a method had
* completed running when a SystemException was thrown.
*/
_COMPLETED_MAYBE = 2;
/**
* An instance of CompletionStatus initialized with
* the constant _COMPLETED_YES.
*/
public static final CompletionStatus COMPLETED_YES = new CompletionStatus(_COMPLETED_YES);
/**
* An instance of CompletionStatus initialized with
* the constant _COMPLETED_NO.
*/
public static final CompletionStatus COMPLETED_NO = new CompletionStatus(_COMPLETED_NO);
/**
* An instance of CompletionStatus initialized with
* the constant _COMPLETED_MAYBE.
*/
public static final CompletionStatus COMPLETED_MAYBE = new CompletionStatus(_COMPLETED_MAYBE);
/**
* Retrieves the value of this CompletionStatus object.
*
* @return one of the possible CompletionStatus values:
* _COMPLETED_YES, _COMPLETED_NO, or
* _COMPLETED_MAYBE
*
*/
public int value() { return _value; }
/**
* Creates a CompletionStatus object from the given int.
*
* @param i one of _COMPLETED_YES, _COMPLETED_NO, or
* _COMPLETED_MAYBE
*
* @return one of the possible CompletionStatus objects
* with values:
* _COMPLETED_YES, _COMPLETED_NO, or
* _COMPLETED_MAYBE
*
* @exception org.omg.CORBA.BAD_PARAM if the argument given is not one of the
* int constants defined in CompletionStatus
*/
public static CompletionStatus from_int(int i) {
switch (i) {
case _COMPLETED_YES:
return COMPLETED_YES;
case _COMPLETED_NO:
return COMPLETED_NO;
case _COMPLETED_MAYBE:
return COMPLETED_MAYBE;
default:
throw new org.omg.CORBA.BAD_PARAM();
}
}
/**
* Creates a CompletionStatus object from the given int.
*
* @param _value one of _COMPLETED_YES, _COMPLETED_NO, or
* _COMPLETED_MAYBE
*
*/
private CompletionStatus(int _value) {
this._value = _value;
}
private int _value;
}