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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XEnumeration_idl__
  20 #define __com_sun_star_container_XEnumeration_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module container {
  31
  32
  33 /** provides functionality to enumerate the contents of a container.
  34
  35     <p>An object that implements the XEnumeration interface
  36     generates a series of elements, one at a time. Successive calls to
  37     the <code>XEnumeration::nextElement</code> method return successive
  38     elements of the series.  </p>
  39
  40     <p>For example (Java), to print all elements of a vector <var>aVect</var>:
  41     </p>
  42
  43     @code{.java}
  44     for (XEnumeration xEnum = aVect.elements() ; xEnum.hasMoreElements() ; )
  45     {
  46         System.out.println( xEnum.nextElement() );
  47     }
  48     @endcode
  49
  50
  51     <p> If the object changed, the behavior of the enumeration is
  52     not specified. This is not a remote interface.  </p>
  53  */
  54 published interface XEnumeration: com::sun::star::uno::XInterface
  55 {
  56
  57     /** tests whether this enumeration contains more elements.
  58      */
  59     boolean hasMoreElements();
  60
  61
  62     /** @returns
  63             the next element of this enumeration.
  64
  65         @throws  NoSuchElementException
  66             if no more elements exist.
  67
  68         @throws  com::sun::star::lang::WrappedTargetException
  69             If the implementation has internal reasons for exceptions,
  70             then wrap these in a com::sun::star::lang::WrappedTargetException
  71             exception.
  72      */
  73     any nextElement()
  74             raises( com::sun::star::container::NoSuchElementException,
  75                     com::sun::star::lang::WrappedTargetException );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */