libkern/libkern/c++/OSIterator.h

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