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