org.omg.CORBA.ContextList 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 containing a modifiable list of String objects
 * that represent property names.
 * This class is used in Request operations to
 * describe the contexts that need to be resolved and sent with the
 * invocation.  (A context is resolved by giving a property name
 * and getting back the value associated with it.)  This is done
 * by calling the Context method
 * get_values and supplying a string from a
 * ContextList object as the third parameter.
 * The method get_values returns an NVList
 * object containing the NamedValue objects that hold
 * the value(s) identified by the given string.
 * 
 * A ContextList object is created by the ORB, as
 * illustrated here:
 * 
 *   ORB orb = ORB.init(args, null);
 *   org.omg.CORBA.ContextList ctxList = orb.create_context_list();
 * 
 * The variable ctxList represents an empty
 * ContextList object.  Strings are added to
 * the list with the method add, accessed
 * with the method item, and removed with the
 * method remove.
 *
 * @see Context
 * @version 1.2, 09/09/97
 * @since   JDK1.2
 */

public abstract class ContextList {

    /**
     * Returns the number of String objects in this
     * ContextList object.
     *
     * @return                  an int representing the number of
     * Strings in this ContextList object
     */

    public abstract int count();

    /**
     * Adds a String object to this ContextList
     * object.
     *
     * @param ctx               the String object to be added
     */

    public abstract void add(String ctx);

    /**
     * Returns the String object at the given index.
     *
     * @param index             the index of the string desired, with 0 being the
     index of the first string
     * @return                  the string at the given index
     * @exception org.omg.CORBA.Bounds  if the index is greater than
     *                          or equal to the number of strings in this
     *                ContextList object
     */

    public abstract String item(int index) throws org.omg.CORBA.Bounds;

    /**
     * Removes the String object at the given index. Note that
     * the indices of all strings following the one removed are
     * shifted down by one.
     *
     * @param index     the index of the String object to be removed,
     *                with 0 designating the first string
     * @exception org.omg.CORBA.Bounds  if the index is greater than
     *                          or equal to the number of String objects in
     *                this ContextList object
     */

    public abstract void remove(int index) throws org.omg.CORBA.Bounds;

}