org.omg.CORBA.ExceptionList 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 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.
*
* @version 1.13, 09/09/97
* @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;
}