1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_container_XEnumeration_idl__ 24#define __com_sun_star_container_XEnumeration_idl__ 25 26#ifndef __com_sun_star_uno_XInterface_idl__ 27#include <com/sun/star/uno/XInterface.idl> 28#endif 29 30#ifndef __com_sun_star_container_NoSuchElementException_idl__ 31#include <com/sun/star/container/NoSuchElementException.idl> 32#endif 33 34#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 35#include <com/sun/star/lang/WrappedTargetException.idl> 36#endif 37 38 39//============================================================================= 40 41module com { module sun { module star { module container { 42 43//============================================================================= 44 45/** provides functionality to enumerate the contents of a container. 46 47 <p>An object that implements the <type>XEnumeration</type> interface 48 generates a series of elements, one at a time. Successive calls to 49 the <code>XEnumeration::nextElement</code> method return successive 50 elements of the series. </p> 51 52 <p>For example (Java), to print all elements of a vector <var>aVect</var>: 53 </p> 54 55 <listing> 56 for ( XEnumeration xEnum = aVect.elements() ; 57 xEnum.hasMoreElements() ; ) 58 { 59 System.out.println( xEnum.nextElement() ); 60 } 61 </listing> 62 63 64 <p> If the object changed, the behavior of the enumeration is 65 not specified. This is not a remote interface. </p> 66 */ 67published interface XEnumeration: com::sun::star::uno::XInterface 68{ 69 //------------------------------------------------------------------------- 70 71 /** tests whether this enumeration contains more elements. 72 */ 73 boolean hasMoreElements(); 74 75 //------------------------------------------------------------------------- 76 77 /** @returns 78 the next element of this enumeration. 79 80 @throws NoSuchElementException 81 if no more elements exist. 82 83 @throws com::sun::star::lang::WrappedTargetException 84 If the implementation has internal reasons for exceptions, 85 then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 86 exception. 87 */ 88 any nextElement() 89 raises( com::sun::star::container::NoSuchElementException, 90 com::sun::star::lang::WrappedTargetException ); 91 92}; 93 94//============================================================================= 95 96}; }; }; }; 97 98#endif 99