OOFilteringEnumerator Class Reference

#include <OOFilteringEnumerator.h>

Inheritance diagram for OOFilteringEnumerator:

Collaboration diagram for OOFilteringEnumerator:

Instance Methods
(id)	- initWithUnderlyingEnumerator:withSelector:takingArgument:argumentValue:
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- shortDescriptionComponents [implementation]
(id)	- nextObject [implementation]

Class Methods
(id)	+ filterEnumerator:withSelector:
(id)	+ filterEnumerator:withSelector:andArgument:

Private Attributes
NSEnumerator *	_underlyingEnum
SEL	_selector
id	_argument
BOOL	_takesArgument

Detailed Description

Definition at line 57 of file OOFilteringEnumerator.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Definition at line 33 of file OOFilteringEnumerator.m.

{
    [_underlyingEnum release];
    [_argument release];
    
    [super dealloc];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 33 of file OOFilteringEnumerator.m.

{
    NSString *subDesc = NSStringFromSelector(_selector);
    if (_takesArgument)
    {
        subDesc = [subDesc stringByAppendingString:[_argument shortDescription]];
    }
    
    return [NSString stringWithFormat:@"%@ matching %@", [_underlyingEnum shortDescription], subDesc];
}

filterEnumerator:withSelector:

+ (id) filterEnumerator:		(NSEnumerator *)	enumerator
withSelector:		(SEL)	selector

Definition at line 33 of file OOFilteringEnumerator.m.

                       :(NSEnumerator *)enumerator withSelector:(SEL)selector
{
    if (selector == NULL)  return [[enumerator retain] autorelease];
    
    return [[[self alloc] initWithUnderlyingEnumerator:enumerator
                                          withSelector:selector
                                        takingArgument:NO
                                         argumentValue:nil]
                          autorelease];
}

filterEnumerator:withSelector:andArgument:

+ (id) filterEnumerator:		(NSEnumerator *)	enumerator
withSelector:		(SEL)	selector
andArgument:		(id)	argument

Definition at line 33 of file OOFilteringEnumerator.m.

                       :(NSEnumerator *)enumerator withSelector:(SEL)selector andArgument:(id)argument
{
    if (selector == NULL)  return [[enumerator retain] autorelease];
    
    return [[[self alloc] initWithUnderlyingEnumerator:enumerator
                                          withSelector:selector
                                        takingArgument:YES
                                         argumentValue:argument]
            autorelease];
}

initWithUnderlyingEnumerator:withSelector:takingArgument:argumentValue:

- (id) initWithUnderlyingEnumerator:		(NSEnumerator *)	enumerator
withSelector:		(SEL)	selector
takingArgument:		(BOOL)	takesArgument
argumentValue:		(id)	argument

Definition at line 33 of file OOFilteringEnumerator.m.

                                   :(NSEnumerator *)enumerator
                       withSelector:(SEL)selector
                     takingArgument:(BOOL)takesArgument
                      argumentValue:(id)argument
{
    self = [super init];
    if (self != nil)
    {
        _underlyingEnum = [enumerator retain];
        _selector = selector;
        _takesArgument = takesArgument;
        if (_takesArgument)
        {
            _argument = [argument retain];
        }
    }
    return self;
}

nextObject

- (id) nextObject

implementation

Definition at line 33 of file OOFilteringEnumerator.m.

{
    for (;;)
    {
        // Get next object
        id obj = [_underlyingEnum nextObject];
        BOOL filter;
        
        if (obj == nil)
        {
            // End of enumeration
            if (_underlyingEnum != nil)
            {
                [_underlyingEnum release];
                _underlyingEnum = nil;
                [_argument release];
                _argument = nil;
            }
            return nil;
        }
        
        // Check against filter
        IMP predicate = [obj methodForSelector:_selector];
        if (predicate != NULL)
        {
            if (!_takesArgument)
            {
                filter = ((BoolReturnMsgSend)predicate)(obj, _selector);
            }
            else
            {
                filter = ((BoolReturnWithParamMsgSend)predicate)(obj, _selector, _argument);
            }
        }
        else
        {
            // Unsupported method
            filter = NO;
        }
        
        // If object passed, return it.
        if (filter)  return obj;
    }
}

shortDescriptionComponents

- (NSString *) shortDescriptionComponents

implementation

Definition at line 33 of file OOFilteringEnumerator.m.

{
    return NSStringFromSelector(_selector);
}

Member Data Documentation

_argument

- (id) _argument

private

Definition at line 62 of file OOFilteringEnumerator.h.

_selector

- (SEL) _selector

private

Definition at line 61 of file OOFilteringEnumerator.h.

_takesArgument

- (BOOL) _takesArgument

private

Definition at line 63 of file OOFilteringEnumerator.h.

_underlyingEnum

- (NSEnumerator*) _underlyingEnum

private

Definition at line 60 of file OOFilteringEnumerator.h.

---

The documentation for this class was generated from the following files:

• src/Core/OOFilteringEnumerator.h
• src/Core/OOFilteringEnumerator.m