001/* BindingIterator.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CosNaming;
040
041import org.omg.CORBA.portable.IDLEntity;
042
043import java.io.Serializable;
044
045/**
046 * The iterator for seing the available bindings.
047 *
048 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
049 */
050public interface BindingIterator
051  extends BindingIteratorOperations, org.omg.CORBA.Object, Serializable,
052          IDLEntity
053{
054  /**
055   * Destroy the iterator on the server side. This must always be
056   * called, as otherwise the iterator will remain on the server even
057   * after the client application terminates.
058   *
059   * @specnote since 1.3 this method has moved into BindingIteratorOperations.
060   */
061  void destroy();
062
063  /**
064   * Return the desired amount of bindings.
065   *
066   * @param amount the maximal number of bindings to return.
067   * @param a_list a holder to store the returned bindings.
068   *
069   * @return false if there are no more bindings available,
070   * true otherwise.
071   *
072   * @specnote since 1.3 this method has moved into BindingIteratorOperations.
073   */
074  boolean next_n(int amount, BindingListHolder a_list);
075
076  /**
077   * Return the next binding.
078   *
079   * @param a_binding a holder, where the next binding will be stored.
080   *
081   * @return false if there are no more bindings available, true
082   * otherwise.
083   *
084   * @specnote since 1.3 this method has moved into BindingIteratorOperations.
085   */
086  boolean next_one(BindingHolder a_binding);
087}