jem::util::Enumerable Class Reference

Represents an enumerable set of objects. More...

#include <jem/util/Enumerable.h>

Inheritance diagram for jem::util::Enumerable:

Public Member Functions
virtual Ref< Enumerator >	getEnumerator () const =0
	Returns an enumerator over all objects. More...

Protected Member Functions
virtual	~Enumerable ()
Protected Member Functions inherited from jem::Interface
virtual	~Interface ()
	Empty destructor. More...

Detailed Description

The interface class Enumerable provides a uniform way to get access to a set of objects. It declares a single function – getEnumerator() – that returns an enumerator over all objects in an Enumerable object.

See also

Enumerator

Constructor & Destructor Documentation

virtual jem::util::Enumerable::~Enumerable ( )

protectedvirtual

Member Function Documentation

virtual Ref<Enumerator> jem::util::Enumerable::getEnumerator ( ) const

pure virtual

Returns an Enumerator that can be used to iterate over all objects encapsulated by this Enumerable object. The returned enumerator points to the first object in this Enumerable, or to the end object if this Enumerable is empty.

Returns

An Enumerator over all objects in this Enumerable.

Implemented in jem::util::Dictionary, jem::util::ObjectCollection, jem::util::ObjectMap, and jem::util::ObjectSequence.