Mercurial > jdk8-mips64-public > corba / annotate
src/share/classes/org/omg/CORBA/ExceptionList.java@7ef37b2cdcad (annotated)
src/share/classes/org/omg/CORBA/ExceptionList.java
Wed, 27 Apr 2016 01:21:28 +0800
- author
- aoqi
- date
- Wed, 27 Apr 2016 01:21:28 +0800
- changeset 0
- 7ef37b2cdcad
- child 748
- 6845b95cba6b
- permissions
- -rw-r--r--
Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/corba/
changeset: 765:f46df0af2ca8
tag: jdk8u25-b17
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1996, 1999, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package org.omg.CORBA; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | /** |
| aoqi@0 | 29 | * An object used in <code>Request</code> operations to |
| aoqi@0 | 30 | * describe the exceptions that can be thrown by a method. It maintains a |
| aoqi@0 | 31 | * modifiable list of <code>TypeCode</code>s of the exceptions. |
| aoqi@0 | 32 | * <P> |
| aoqi@0 | 33 | * The following code fragment demonstrates creating |
| aoqi@0 | 34 | * an <code>ExceptionList</code> object: |
| aoqi@0 | 35 | * <PRE> |
| aoqi@0 | 36 | * ORB orb = ORB.init(args, null); |
| aoqi@0 | 37 | * org.omg.CORBA.ExceptionList excList = orb.create_exception_list(); |
| aoqi@0 | 38 | * </PRE> |
| aoqi@0 | 39 | * The variable <code>excList</code> represents an <code>ExceptionList</code> |
| aoqi@0 | 40 | * object with no <code>TypeCode</code> objects in it. |
| aoqi@0 | 41 | * <P> |
| aoqi@0 | 42 | * To add items to the list, you first create a <code>TypeCode</code> object |
| aoqi@0 | 43 | * for the exception you want to include, using the <code>ORB</code> method |
| aoqi@0 | 44 | * <code>create_exception_tc</code>. Then you use the <code>ExceptionList</code> |
| aoqi@0 | 45 | * method <code>add</code> to add it to the list. |
| aoqi@0 | 46 | * The class <code>ExceptionList</code> has a method for getting |
| aoqi@0 | 47 | * the number of <code>TypeCode</code> objects in the list, and after |
| aoqi@0 | 48 | * items have been added, it is possible to call methods for accessing |
| aoqi@0 | 49 | * or deleting an item at a designated index. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * @since JDK1.2 |
| aoqi@0 | 52 | */ |
| aoqi@0 | 53 | |
| aoqi@0 | 54 | public abstract class ExceptionList { |
| aoqi@0 | 55 | |
| aoqi@0 | 56 | /** |
| aoqi@0 | 57 | * Retrieves the number of <code>TypeCode</code> objects in this |
| aoqi@0 | 58 | * <code>ExceptionList</code> object. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @return the number of <code>TypeCode</code> objects in this |
| aoqi@0 | 61 | * <code>ExceptionList</code> object |
| aoqi@0 | 62 | */ |
| aoqi@0 | 63 | |
| aoqi@0 | 64 | public abstract int count(); |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** |
| aoqi@0 | 67 | * Adds a <code>TypeCode</code> object describing an exception |
| aoqi@0 | 68 | * to this <code>ExceptionList</code> object. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param exc the <code>TypeCode</code> object to be added |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | |
| aoqi@0 | 73 | public abstract void add(TypeCode exc); |
| aoqi@0 | 74 | |
| aoqi@0 | 75 | /** |
| aoqi@0 | 76 | * Returns the <code>TypeCode</code> object at the given index. The first |
| aoqi@0 | 77 | * item is at index 0. |
| aoqi@0 | 78 | * |
| aoqi@0 | 79 | * @param index the index of the <code>TypeCode</code> object desired. |
| aoqi@0 | 80 | * This must be an <code>int</code> between 0 and the |
| aoqi@0 | 81 | * number of <code>TypeCode</code> objects |
| aoqi@0 | 82 | * minus one, inclusive. |
| aoqi@0 | 83 | * @return the <code>TypeCode</code> object at the given index |
| aoqi@0 | 84 | * @exception org.omg.CORBA.Bounds if the index given is greater than |
| aoqi@0 | 85 | * or equal to the number of <code>TypeCode</code> objects |
| aoqi@0 | 86 | * in this <code>ExceptionList</code> object |
| aoqi@0 | 87 | */ |
| aoqi@0 | 88 | |
| aoqi@0 | 89 | public abstract TypeCode item(int index) |
| aoqi@0 | 90 | throws org.omg.CORBA.Bounds; |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | /** |
| aoqi@0 | 93 | * Removes the <code>TypeCode</code> object at the given index. |
| aoqi@0 | 94 | * Note that the indices of all the <code>TypeCoded</code> objects |
| aoqi@0 | 95 | * following the one deleted are shifted down by one. |
| aoqi@0 | 96 | * |
| aoqi@0 | 97 | * @param index the index of the <code>TypeCode</code> object to be |
| aoqi@0 | 98 | * removed. |
| aoqi@0 | 99 | * This must be an <code>int</code> between 0 and the |
| aoqi@0 | 100 | * number of <code>TypeCode</code> objects |
| aoqi@0 | 101 | * minus one, inclusive. |
| aoqi@0 | 102 | * |
| aoqi@0 | 103 | * @exception org.omg.CORBA.Bounds if the index is greater than |
| aoqi@0 | 104 | * or equal to the number of <code>TypeCode</code> objects |
| aoqi@0 | 105 | * in this <code>ExceptionList</code> object |
| aoqi@0 | 106 | */ |
| aoqi@0 | 107 | |
| aoqi@0 | 108 | public abstract void remove(int index) |
| aoqi@0 | 109 | throws org.omg.CORBA.Bounds; |
| aoqi@0 | 110 | } |
