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

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