/*
* Copyright (c) 1996, 1999, 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 used in Request
operations to
* describe the exceptions that can be thrown by a method. It maintains a
* modifiable list of TypeCode
s of the exceptions.
*
* The following code fragment demonstrates creating
* an ExceptionList
object:
*
* ORB orb = ORB.init(args, null); * org.omg.CORBA.ExceptionList excList = orb.create_exception_list(); ** The variable
excList
represents an ExceptionList
* object with no TypeCode
objects in it.
*
* To add items to the list, you first create a TypeCode
object
* for the exception you want to include, using the ORB
method
* create_exception_tc
. Then you use the ExceptionList
* method add
to add it to the list.
* The class ExceptionList
has a method for getting
* the number of TypeCode
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 TypeCode
objects in this
* ExceptionList
object.
*
* @return the number of TypeCode
objects in this
* ExceptionList
object
*/
public abstract int count();
/**
* Adds a TypeCode
object describing an exception
* to this ExceptionList
object.
*
* @param exc the TypeCode
object to be added
*/
public abstract void add(TypeCode exc);
/**
* Returns the TypeCode
object at the given index. The first
* item is at index 0.
*
* @param index the index of the TypeCode
object desired.
* This must be an int
between 0 and the
* number of TypeCode
objects
* minus one, inclusive.
* @return the TypeCode
object at the given index
* @exception org.omg.CORBA.Bounds if the index given is greater than
* or equal to the number of TypeCode
objects
* in this ExceptionList
object
*/
public abstract TypeCode item(int index)
throws org.omg.CORBA.Bounds;
/**
* Removes the TypeCode
object at the given index.
* Note that the indices of all the TypeCoded
objects
* following the one deleted are shifted down by one.
*
* @param index the index of the TypeCode
object to be
* removed.
* This must be an int
between 0 and the
* number of TypeCode
objects
* minus one, inclusive.
*
* @exception org.omg.CORBA.Bounds if the index is greater than
* or equal to the number of TypeCode
objects
* in this ExceptionList
object
*/
public abstract void remove(int index)
throws org.omg.CORBA.Bounds;
}