udkapi/com/sun/star/container/XEnumeration.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XEnumeration.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_container_XEnumeration_idl__
  31 #define __com_sun_star_container_XEnumeration_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  38 #include <com/sun/star/container/NoSuchElementException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  42 #include <com/sun/star/lang/WrappedTargetException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module container {
  49
  50 //=============================================================================
  51
  52 /** provides functionality to enumerate the contents of a container.
  53
  54     <p>An object that implements the <type>XEnumeration</type> interface
  55     generates a series of elements, one at a time. Successive calls to
  56     the <code>XEnumeration::nextElement</code> method return successive
  57     elements of the series.  </p>
  58
  59     <p>For example (Java), to print all elements of a vector <var>aVect</var>:
  60     </p>
  61
  62     <listing>
  63     for ( XEnumeration xEnum = aVect.elements() ;
  64     xEnum.hasMoreElements() ; )
  65     {
  66     System.out.println( xEnum.nextElement() );
  67     }
  68     </listing>
  69
  70
  71     <p> If the object changed, the behavior of the enumeration is
  72     not specified. This is not a remote interface.  </p>
  73  */
  74 published interface XEnumeration: com::sun::star::uno::XInterface
  75 {
  76     //-------------------------------------------------------------------------
  77
  78     /** tests whether this enumeration contains more elements.
  79      */
  80     boolean hasMoreElements();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** @returns
  85             the next element of this enumeration.
  86
  87         @throws  NoSuchElementException
  88             if no more elements exist.
  89
  90         @throws  com::sun::star::lang::WrappedTargetException
  91             If the implementation has internal reasons for exceptions,
  92             then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
  93             exception.
  94      */
  95     any nextElement()
  96             raises( com::sun::star::container::NoSuchElementException,
  97                     com::sun::star::lang::WrappedTargetException );
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif