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