libkern/libkern/c++/OSIterator.h

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