org.omg.CORBA.CompletionStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjdk-orb Show documentation
JBoss repackaging of the OpenJDK ORB
The newest version!
/*
 * Copyright (c) 1996, 2000, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
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
 * 
 * @see     org.omg.CORBA.SystemException
 * @since   JDK1.2
 */

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;
}