libkern/libkern/c++/OSIterator.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1998-1999 Apple Computer, Inc.  All rights reserved.
  25  *
  26  * HISTORY
  27  *
  28  */
  29
  30 #ifndef _OS_OSITERATOR_H
  31 #define _OS_OSITERATOR_H
  32
  33 #include <libkern/c++/OSObject.h>
  34
  35 /*!
  36     @class OSIterator
  37     @abstract Abstract super class for iterator classes.
  38     @discussion
  39     OSIterator is an abstract super class providing a consistent set of API's for subclasses.
  40 */
  41 class OSIterator : public OSObject
  42 {
  43     OSDeclareAbstractStructors(OSIterator)
  44
  45 public:
  46     /*!
  47         @function reset
  48         @abstract A pure virtual member function to be over-ridden by the subclass which reset the iterator to the beginning of the collection.
  49     */
  50     virtual void reset() = 0;
  51
  52     /*!
  53         @function isValid
  54         @abstract A pure virtual member function to be over-ridden by the subclass which indicates a modification was made to the collection.
  55     */
  56     virtual bool isValid() = 0;
  57
  58     /*!
  59         @function getNextObject
  60         @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.
  61     */
  62     virtual OSObject *getNextObject() = 0;
  63
  64     OSMetaClassDeclareReservedUnused(OSIterator, 0);
  65     OSMetaClassDeclareReservedUnused(OSIterator, 1);
  66     OSMetaClassDeclareReservedUnused(OSIterator, 2);
  67     OSMetaClassDeclareReservedUnused(OSIterator, 3);
  68 };
  69
  70 #endif /* ! _OS_OSITERATOR_H */