libkern/libkern/c++/OSIterator.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 /*
  23  * Copyright (c) 1998-1999 Apple Computer, Inc.  All rights reserved.
  24  *
  25  * HISTORY
  26  *
  27  */
  28
  29 #ifndef _OS_OSITERATOR_H
  30 #define _OS_OSITERATOR_H
  31
  32 #include <libkern/c++/OSObject.h>
  33
  34 /*!
  35     @class OSIterator
  36     @abstract Abstract super class for iterator classes.
  37     @discussion
  38     OSIterator is an abstract super class providing a consistent set of API's for subclasses.
  39 */
  40 class OSIterator : public OSObject
  41 {
  42     OSDeclareAbstractStructors(OSIterator)
  43
  44 public:
  45     /*!
  46         @function reset
  47         @abstract A pure virtual member function to be over-ridden by the subclass which reset the iterator to the beginning of the collection.
  48     */
  49     virtual void reset() = 0;
  50
  51     /*!
  52         @function isValid
  53         @abstract A pure virtual member function to be over-ridden by the subclass which indicates a modification was made to the collection.
  54     */
  55     virtual bool isValid() = 0;
  56
  57     /*!
  58         @function getNextObject
  59         @abstract A pure virtual function to be over-ridden by the subclass which returns a reference to the current object in the collection and advances the interator to the next object.
  60     */
  61     virtual OSObject *getNextObject() = 0;
  62
  63     OSMetaClassDeclareReservedUnused(OSIterator, 0);
  64     OSMetaClassDeclareReservedUnused(OSIterator, 1);
  65     OSMetaClassDeclareReservedUnused(OSIterator, 2);
  66     OSMetaClassDeclareReservedUnused(OSIterator, 3);
  67 };
  68
  69 #endif /* ! _OS_OSITERATOR_H */