blob: 0622f7067c02b5989a5853813982e41b92aaea03 [file] [log] [blame]
Jorge Canizalese8304d52015-02-17 19:50:51 -08001/*
2 *
Yang Gao5fc90292015-02-20 09:46:22 -08003 * Copyright 2015, Google Inc.
Jorge Canizalese8304d52015-02-17 19:50:51 -08004 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
Jorge Canizales30697c92015-02-17 17:09:14 -080034#import <Foundation/Foundation.h>
35
36@interface NSEnumerator (GRXUtil)
37
Jorge Canizalesb10776c2015-10-26 10:44:55 -070038/**
39 * Returns a NSEnumerator instance that iterates through the elements of the passed container that
40 * supports fast enumeration. Note that this negates the speed benefits of fast enumeration over
41 * NSEnumerator. It's only intended for the rare cases when one needs the latter and only has the
42 * former, e.g. for iteration that needs to be paused and resumed later.
43 */
Jorge Canizales30697c92015-02-17 17:09:14 -080044+ (NSEnumerator *)grx_enumeratorWithContainer:(id<NSFastEnumeration>)container;
45
Jorge Canizalesb10776c2015-10-26 10:44:55 -070046/**
47 * Returns a NSEnumerator instance that provides a single object before finishing. The value is then
48 * released.
49 */
Jorge Canizales30697c92015-02-17 17:09:14 -080050+ (NSEnumerator *)grx_enumeratorWithSingleValue:(id)value;
51
Jorge Canizalesb10776c2015-10-26 10:44:55 -070052/**
53 * Returns a NSEnumerator instance that delegates the invocations of nextObject to the passed block.
54 * When the block first returns nil, it is released.
55 */
Jorge Canizales30697c92015-02-17 17:09:14 -080056+ (NSEnumerator *)grx_enumeratorWithValueSupplier:(id (^)())block;
57@end