ExceptionList.java revision 157
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync/*
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync *
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This code is free software; you can redistribute it and/or modify it
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * under the terms of the GNU General Public License version 2 only, as
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * published by the Free Software Foundation. Oracle designates this
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * particular file as subject to the "Classpath" exception as provided
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * by Oracle in the LICENSE file that accompanied this code.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync *
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * This code is distributed in the hope that it will be useful, but WITHOUT
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * version 2 for more details (a copy is included in the LICENSE file that
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * accompanied this code).
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync *
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * You should have received a copy of the GNU General Public License version
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * 2 along with this work; if not, write to the Free Software Foundation,
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync *
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * or visit www.oracle.com if you need additional information or have any
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * questions.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync */
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsyncpackage org.omg.CORBA;
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync/**
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * An object used in <code>Request</code> operations to
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * describe the exceptions that can be thrown by a method. It maintains a
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * modifiable list of <code>TypeCode</code>s of the exceptions.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * <P>
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The following code fragment demonstrates creating
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * an <code>ExceptionList</code> object:
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * <PRE>
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * ORB orb = ORB.init(args, null);
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * org.omg.CORBA.ExceptionList excList = orb.create_exception_list();
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * </PRE>
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * The variable <code>excList</code> represents an <code>ExceptionList</code>
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * object with no <code>TypeCode</code> objects in it.
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * <P>
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * To add items to the list, you first create a <code>TypeCode</code> object
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * for the exception you want to include, using the <code>ORB</code> method
14ea49401f3c8c61422aefbda43809e275f60c6cvboxsync * <code>create_exception_tc</code>. Then you use the <code>ExceptionList</code>
* method <code>add</code> to add it to the list.
* The class <code>ExceptionList</code> has a method for getting
* the number of <code>TypeCode</code> objects in the list, and after
* items have been added, it is possible to call methods for accessing
* or deleting an item at a designated index.
*
* @since JDK1.2
*/
public abstract class ExceptionList {
/**
* Retrieves the number of <code>TypeCode</code> objects in this
* <code>ExceptionList</code> object.
*
* @return the number of <code>TypeCode</code> objects in this
* <code>ExceptionList</code> object
*/
public abstract int count();
/**
* Adds a <code>TypeCode</code> object describing an exception
* to this <code>ExceptionList</code> object.
*
* @param exc the <code>TypeCode</code> object to be added
*/
public abstract void add(TypeCode exc);
/**
* Returns the <code>TypeCode</code> object at the given index. The first
* item is at index 0.
*
* @param index the index of the <code>TypeCode</code> object desired.
* This must be an <code>int</code> between 0 and the
* number of <code>TypeCode</code> objects
* minus one, inclusive.
* @return the <code>TypeCode</code> object at the given index
* @exception org.omg.CORBA.Bounds if the index given is greater than
* or equal to the number of <code>TypeCode</code> objects
* in this <code>ExceptionList</code> object
*/
public abstract TypeCode item(int index)
throws org.omg.CORBA.Bounds;
/**
* Removes the <code>TypeCode</code> object at the given index.
* Note that the indices of all the <code>TypeCoded</code> objects
* following the one deleted are shifted down by one.
*
* @param index the index of the <code>TypeCode</code> object to be
* removed.
* This must be an <code>int</code> between 0 and the
* number of <code>TypeCode</code> objects
* minus one, inclusive.
*
* @exception org.omg.CORBA.Bounds if the index is greater than
* or equal to the number of <code>TypeCode</code> objects
* in this <code>ExceptionList</code> object
*/
public abstract void remove(int index)
throws org.omg.CORBA.Bounds;
}