00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_ENUMERATION_HPP 00008 #define COH_ENUMERATION_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 COH_OPEN_NAMESPACE2(coherence,util) 00013 00014 00015 /** 00016 * An object that implements the Enumeration interface generates a series of 00017 * elements, one at a time. Successive calls to the nextElement method return 00018 * successive elements of the series. 00019 * 00020 * @author tb 2010.10.16 00021 */ 00022 class COH_EXPORT Enumeration 00023 : public interface_spec<Enumeration> 00024 { 00025 // ----- Enumeration interface --------------------------------------------- 00026 00027 public: 00028 /** 00029 * Tests if this enumeration contains more elements. 00030 * 00031 * @return true if and only if this enumeration object contains at 00032 * least one more element to provide; false otherwise 00033 */ 00034 virtual bool hasMoreElements() const = 0; 00035 00036 /** 00037 * Returns the next element of this enumeration if this enumeration 00038 * object has at least one more element to provide. 00039 * 00040 * @return the next element of this enumeration 00041 * 00042 * @throws coherence::lang::NoSuchElementException if no more elements 00043 * exist. 00044 */ 00045 virtual Object::Holder nextElement() = 0; 00046 }; 00047 00048 COH_CLOSE_NAMESPACE2 00049 00050 #endif // COH_ENUMERATION_HPP