libkern/libkern/c++/OSIterator.h

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