Java example source code file (CompletionStatus.java)

This example Java source code file (CompletionStatus.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

completed_maybe, completed_no, completed_yes, completionstatus

The CompletionStatus.java Java example source code

/*
 * 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 <code>SystemException was thrown.
 * <P>
 * The class <code>CompletionStatus
 * contains three <code>CompletionStatus instances, which are constants
 * representing each
 * possible completion status: <code>COMPLETED_MAYBE,
 * <code>COMPLETED_NO, and COMPLETED_YES.
 * It also contains
 * three <code>int members, each a constant corresponding to one of
 * the <code>CompletionStatus instances.  These int
 * members make it possible to use a <code>switch statement.
 * <P>
 * The class also contains two methods:
 * <UL>
 * <LI>public int value() -- which accesses the
 * <code>value field of a CompletionStatus object
 * <LI>public static CompletionStatus
 * <bold>from_int(int i) --
 * for creating an instance from one of the <code>int members
 * </UL>
 * @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 <code>SystemException was thrown.
 */
    public static final int _COMPLETED_YES = 0,

/**
 * The constant indicating that a method had not completed running
 * when a <code>SystemException was thrown.
 */
        _COMPLETED_NO = 1,

/**
 * The constant indicating that it is unknown whether a method had
 * completed running when a <code>SystemException was thrown.
 */
        _COMPLETED_MAYBE = 2;


/**
 * An instance of <code>CompletionStatus initialized with
 * the constant <code>_COMPLETED_YES.
 */
    public static final CompletionStatus COMPLETED_YES   = new CompletionStatus(_COMPLETED_YES);

/**
 * An instance of <code>CompletionStatus initialized with
 * the constant <code>_COMPLETED_NO.
 */
    public static final CompletionStatus COMPLETED_NO    = new CompletionStatus(_COMPLETED_NO);

    /**
 * An instance of <code>CompletionStatus initialized with
 * the constant <code>_COMPLETED_MAYBE.
 */
    public static final CompletionStatus COMPLETED_MAYBE = new CompletionStatus(_COMPLETED_MAYBE);

    /**
 * Retrieves the value of this <code>CompletionStatus object.
 *
 * @return  one of the possible <code>CompletionStatus values:
 *          <code>_COMPLETED_YES, _COMPLETED_NO, or
 *          <code>_COMPLETED_MAYBE
 *
 */
    public int value() { return _value; }

/**
 * Creates a <code>CompletionStatus object from the given int.
 *
 * @param i  one of <code>_COMPLETED_YES, _COMPLETED_NO, or
 *          <code>_COMPLETED_MAYBE
 *
 * @return  one of the possible <code>CompletionStatus objects
 *          with values:
 *          <code>_COMPLETED_YES, _COMPLETED_NO, or
 *          <code>_COMPLETED_MAYBE
 *
 * @exception org.omg.CORBA.BAD_PARAM  if the argument given is not one of the
 *            <code>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 <code>CompletionStatus object from the given int.
 *
 * @param _value  one of <code>_COMPLETED_YES, _COMPLETED_NO, or
 *          <code>_COMPLETED_MAYBE
 *
 */
    private CompletionStatus(int _value) {
        this._value = _value;
    }

    private int _value;
}