Source for org.omg.CosNaming.BindingIterator

   1: /* BindingIterator.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.CosNaming;
  40: 
  41: import org.omg.CORBA.portable.IDLEntity;
  42: 
  43: import java.io.Serializable;
  44: 
  45: /**
  46:  * The iterator for seing the available bindings.
  47:  *
  48:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  49:  */
  50: public interface BindingIterator
  51:   extends BindingIteratorOperations, org.omg.CORBA.Object, Serializable,
  52:           IDLEntity
  53: {
  54:   /**
  55:    * Destroy the iterator on the server side. This must always be
  56:    * called, as otherwise the iterator will remain on the server even
  57:    * after the client application terminates.
  58:    *
  59:    * @specnote since 1.3 this method has moved into BindingIteratorOperations.
  60:    */
  61:   void destroy();
  62: 
  63:   /**
  64:    * Return the desired amount of bindings.
  65:    *
  66:    * @param amount the maximal number of bindings to return.
  67:    * @param a_list a holder to store the returned bindings.
  68:    *
  69:    * @return false if there are no more bindings available,
  70:    * true otherwise.
  71:    *
  72:    * @specnote since 1.3 this method has moved into BindingIteratorOperations.
  73:    */
  74:   boolean next_n(int amount, BindingListHolder a_list);
  75: 
  76:   /**
  77:    * Return the next binding.
  78:    *
  79:    * @param a_binding a holder, where the next binding will be stored.
  80:    *
  81:    * @return false if there are no more bindings available, true
  82:    * otherwise.
  83:    *
  84:    * @specnote since 1.3 this method has moved into BindingIteratorOperations.
  85:    */
  86:   boolean next_one(BindingHolder a_binding);
  87: }