Mercurial > jdk8-mips64-public > corba / annotate
src/share/classes/org/omg/CORBA/ContextList.java@55540e827aef (annotated)
src/share/classes/org/omg/CORBA/ContextList.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 55540e827aef
- child 158
- 91006f157c46
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 1996-1999 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package org.omg.CORBA; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * An object containing a modifiable list of <code>String</code> objects |
| duke@1 | 30 | * that represent property names. |
| duke@1 | 31 | * This class is used in <code>Request</code> operations to |
| duke@1 | 32 | * describe the contexts that need to be resolved and sent with the |
| duke@1 | 33 | * invocation. (A context is resolved by giving a property name |
| duke@1 | 34 | * and getting back the value associated with it.) This is done |
| duke@1 | 35 | * by calling the <code>Context</code> method |
| duke@1 | 36 | * <code>get_values</code> and supplying a string from a |
| duke@1 | 37 | * <code>ContextList</code> object as the third parameter. |
| duke@1 | 38 | * The method <code>get_values</code> returns an <code>NVList</code> |
| duke@1 | 39 | * object containing the <code>NamedValue</code> objects that hold |
| duke@1 | 40 | * the value(s) identified by the given string. |
| duke@1 | 41 | * <P> |
| duke@1 | 42 | * A <code>ContextList</code> object is created by the ORB, as |
| duke@1 | 43 | * illustrated here: |
| duke@1 | 44 | * <PRE> |
| duke@1 | 45 | * ORB orb = ORB.init(args, null); |
| duke@1 | 46 | * org.omg.CORBA.ContextList ctxList = orb.create_context_list(); |
| duke@1 | 47 | * </PRE> |
| duke@1 | 48 | * The variable <code>ctxList</code> represents an empty |
| duke@1 | 49 | * <code>ContextList</code> object. Strings are added to |
| duke@1 | 50 | * the list with the method <code>add</code>, accessed |
| duke@1 | 51 | * with the method <code>item</code>, and removed with the |
| duke@1 | 52 | * method <code>remove</code>. |
| duke@1 | 53 | * |
| duke@1 | 54 | * @see Context |
| duke@1 | 55 | * @since JDK1.2 |
| duke@1 | 56 | */ |
| duke@1 | 57 | |
| duke@1 | 58 | public abstract class ContextList { |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Returns the number of <code>String</code> objects in this |
| duke@1 | 62 | * <code>ContextList</code> object. |
| duke@1 | 63 | * |
| duke@1 | 64 | * @return an <code>int</code> representing the number of |
| duke@1 | 65 | * <code>String</code>s in this <code>ContextList</code> object |
| duke@1 | 66 | */ |
| duke@1 | 67 | |
| duke@1 | 68 | public abstract int count(); |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Adds a <code>String</code> object to this <code>ContextList</code> |
| duke@1 | 72 | * object. |
| duke@1 | 73 | * |
| duke@1 | 74 | * @param ctx the <code>String</code> object to be added |
| duke@1 | 75 | */ |
| duke@1 | 76 | |
| duke@1 | 77 | public abstract void add(String ctx); |
| duke@1 | 78 | |
| duke@1 | 79 | /** |
| duke@1 | 80 | * Returns the <code>String</code> object at the given index. |
| duke@1 | 81 | * |
| duke@1 | 82 | * @param index the index of the string desired, with 0 being the |
| duke@1 | 83 | index of the first string |
| duke@1 | 84 | * @return the string at the given index |
| duke@1 | 85 | * @exception org.omg.CORBA.Bounds if the index is greater than |
| duke@1 | 86 | * or equal to the number of strings in this |
| duke@1 | 87 | * <code>ContextList</code> object |
| duke@1 | 88 | */ |
| duke@1 | 89 | |
| duke@1 | 90 | public abstract String item(int index) throws org.omg.CORBA.Bounds; |
| duke@1 | 91 | |
| duke@1 | 92 | /** |
| duke@1 | 93 | * Removes the <code>String</code> object at the given index. Note that |
| duke@1 | 94 | * the indices of all strings following the one removed are |
| duke@1 | 95 | * shifted down by one. |
| duke@1 | 96 | * |
| duke@1 | 97 | * @param index the index of the <code>String</code> object to be removed, |
| duke@1 | 98 | * with 0 designating the first string |
| duke@1 | 99 | * @exception org.omg.CORBA.Bounds if the index is greater than |
| duke@1 | 100 | * or equal to the number of <code>String</code> objects in |
| duke@1 | 101 | * this <code>ContextList</code> object |
| duke@1 | 102 | */ |
| duke@1 | 103 | |
| duke@1 | 104 | public abstract void remove(int index) throws org.omg.CORBA.Bounds; |
| duke@1 | 105 | |
| duke@1 | 106 | } |
