libkern/libkern/c++/OSCollectionIterator.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* IOCollectionIterator.h created by gvdl on Fri 1998-10-30 */
  23
  24 #ifndef _OS_OSCOLLECTIONITERATOR_H
  25 #define _OS_OSCOLLECTIONITERATOR_H
  26
  27 #include <libkern/c++/OSIterator.h>
  28
  29 class OSCollection;
  30
  31 /*!
  32     @class OSCollectionIterator
  33     @discussion
  34     OSCollectionIterator objects provide a consistent mechanism to iterate through all OSCollection derived collections.
  35 */
  36 class OSCollectionIterator : public OSIterator
  37 {
  38     OSDeclareDefaultStructors(OSCollectionIterator)
  39
  40 protected:
  41     const OSCollection *collection;
  42     void *collIterator;
  43     unsigned int initialUpdateStamp;
  44     bool valid;
  45
  46 public:
  47     /*!
  48         @function withCollection
  49         @abstract A static constructor function which creates and initializes an instance of OSCollectionIterator for the provided collection object.
  50         @param inColl The OSCollection derived collection object to be iteratated.
  51         @result Returns a new instance of OSCollection or 0 on failure.
  52     */
  53     static OSCollectionIterator *withCollection(const OSCollection *inColl);
  54
  55     /*!
  56         @function withCollection
  57         @abstract A member function to initialize the intance of OSCollectionIterator with the provided colleciton object.
  58         @param inColl The OSCollection derived collection object to be iteratated.
  59         @result Returns true if the initialization was successful or false on failure.
  60     */
  61     virtual bool initWithCollection(const OSCollection *inColl);
  62     /*!
  63         @function free
  64         @abstract A member function to release and deallocate all resources created or used by the OSCollectionIterator object.
  65         @discussion This function should not be called directly, use release() instead.
  66     */
  67     virtual void free();
  68
  69     /*!
  70         @function reset
  71         @abstract A member function which resets the iterator to begin the next iteration from the beginning of the collection.
  72     */
  73     virtual void reset();
  74
  75     /*!
  76         @function isValid
  77         @abstract A member function for determining if the collection was modified during iteration.
  78     */
  79     virtual bool isValid();
  80
  81     /*!
  82         @function getNextObject
  83         @abstract A member function to get the next object in the collection being iterated.
  84         @result Returns the next object in the collection or 0 when the end has been reached.
  85     */
  86     virtual OSObject *getNextObject();
  87 };
  88
  89 #endif /* !_OS_OSCOLLECTIONITERATOR_H */