SCCollection.h

Go to the documentation of this file.

//
//  SCCollection.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCCollectionProtocols.h>
#import <scl/SCObject.h>

#pragma mark -
#pragma mark Class Constants

#define SCCollectionClass   @"SCCollection"

#define SCNotFound          NSNotFound


@protocol SCCollectionDelegate;

@interface SCCollection : SCObject <SCMutableCollection, NSFastEnumeration> {
    NSString                    *_name;     // Collection name
    BOOL                         _readOnly; // Read only mode flag
    id<SCCollectionDelegate>     _delegate; // Pointer to the delegate object
}
#pragma mark -
#pragma mark Свойства экземпляра класса

@property (nonatomic, readwrite, retain) NSString *name;

@property (nonatomic, readonly, assign) SCIndex count;

@property (nonatomic, readonly, assign) BOOL empty;

@property (nonatomic, readwrite, assign) BOOL readOnly;

@property (nonatomic, readwrite, retain) id<SCCollectionDelegate> delegate;

@property (nonatomic, readonly, copy) NSString *typeName;

@property (nonatomic, readonly, assign) NSEnumerator *objectEnumerator;

@property (nonatomic, readonly, assign) NSEnumerator *reverseObjectEnumerator;

@property (nonatomic, readonly, assign) SCArray *array;

@property (nonatomic, readonly, assign) SCSet *set;

@property (nonatomic, readonly, assign) SCOrderedSet *orderedSet;

@property (nonatomic, readonly, assign) SCDictionary *dictionary;

@property (nonatomic, readonly, assign) SCStack *stack;

@property (nonatomic, readonly, assign) SCQueue *queue;

@property (nonatomic, readonly, assign) SCUnidirectionalList *unidirectionalList;

@property (nonatomic, readonly, assign) SCBidirectionalList *bidirectionalList;

@property (nonatomic, readonly, assign) NSArray *foundationArray;

@property (nonatomic, readonly, assign) NSSet *foundationSet;

@property (nonatomic, readonly, assign) NSOrderedSet *foundationOrderedSet;

@property (nonatomic, readonly, assign) NSDictionary *foundationDictionary;

@property (nonatomic, readonly, assign) SCCollectionType collectionType;

@property (nonatomic, readonly, assign) BOOL isCollection;

@property (nonatomic, readonly, assign) BOOL isLibraryCollection;

@property (nonatomic, readonly, assign) BOOL isFoundationCollection;

@property (nonatomic, readonly, assign) BOOL isArray;

@property (nonatomic, readonly, assign) BOOL isLibraryArray;

@property (nonatomic, readonly, assign) BOOL isFoundationArray;

@property (nonatomic, readonly, assign) BOOL isSet;

@property (nonatomic, readonly, assign) BOOL isLibrarySet;

@property (nonatomic, readonly, assign) BOOL isFoundationSet;

@property (nonatomic, readonly, assign) BOOL isOrderedSet;

@property (nonatomic, readonly, assign) BOOL isLibraryOrderedSet;

@property (nonatomic, readonly, assign) BOOL isFoundationOrderedSet;

@property (nonatomic, readonly, assign) BOOL isDictionary;

@property (nonatomic, readonly, assign) BOOL isLibraryDictionary;

@property (nonatomic, readonly, assign) BOOL isFoundationDictionary;

@property (nonatomic, readonly, assign) BOOL isStack;

@property (nonatomic, readonly, assign) BOOL isQueue;

@property (nonatomic, readonly, assign) BOOL isList;

@property (nonatomic, readonly, assign) BOOL isSortable;

#pragma mark -
#pragma mark Initializing Collections
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Copying Collections
- (void)setCollection:(id<SCCollection>)collection;
- (void)setObject:(id<SCCollectioning>)object;
- (void)setObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Comparing Collections
- (BOOL)isEqualToCollection:(id<SCCollection>)collection;
- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Objects Enumerators
- (void)enumerateWithDelegate:(id<SCCollectionDelegate>)delegate;
- (void)enumerate;
- (void)reverseEnumerateWithDelegate:(id<SCCollectionDelegate>)delegate;
- (void)reverseEnumerate;
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)buffer count:(NSUInteger)count;

#pragma mark -
#pragma mark Adding Objects
- (void)addObject:(id<SCCollectioning>)object;
- (void)addObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)addCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Removing Objects
- (void)removeAllObjects;
- (void)removeObjectsWithClass:(Class)oclass;
- (void)removeObjectsWithClassName:(NSString *)name;
- (void)removeCollection:(id<SCCollection>)collection;
- (void)removeObject:(id<SCCollectioning>)object;
- (void)removeObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Finding Objects in a Collection
- (BOOL)containsObject:(id<SCCollectioning>)object;
- (BOOL)containsObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsCollection:(id<SCCollection>)collection;
- (BOOL)containsAnyObject:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsAnyObjectFromCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Detecting Collection Type
+ (BOOL)isCollectionClass:(NSString *)name;
+ (BOOL)isLibraryCollectionClass:(NSString *)name;
+ (BOOL)isFoundationCollectionClass:(NSString *)name;
+ (BOOL)isArrayClass:(NSString *)name;
+ (BOOL)isLibraryArrayClass:(NSString *)name;
+ (BOOL)isFoundationArrayClass:(NSString *)name;
+ (BOOL)isSetClass:(NSString *)name;
+ (BOOL)isLibrarySetClass:(NSString *)name;
+ (BOOL)isFoundationSetClass:(NSString *)name;
+ (BOOL)isOrderedSetClass:(NSString *)name;
+ (BOOL)isLibraryOrderedSetClass:(NSString *)name;
+ (BOOL)isFoundationOrderedSetClass:(NSString *)name;
+ (BOOL)isDictionaryClass:(NSString *)name;
+ (BOOL)isLibraryDictionaryClass:(NSString *)name;
+ (BOOL)isFoundationDictionaryClass:(NSString *)name;
+ (BOOL)isStackClass:(NSString *)name;
+ (BOOL)isQueueClass:(NSString *)name;
+ (BOOL)isListClass:(NSString *)name;
+ (BOOL)isSortableClass:(NSString *)name;

+ (BOOL)isCollection:(id)object;
+ (BOOL)isLibraryCollection:(id)object;
+ (BOOL)isFoundationCollection:(id)object;
+ (BOOL)isArray:(id)object;
+ (BOOL)isLibraryArray:(id)object;
+ (BOOL)isFoundationArray:(id)object;
+ (BOOL)isSet:(id)object;
+ (BOOL)isLibrarySet:(id)object;
+ (BOOL)isFoundationSet:(id)object;
+ (BOOL)isOrderedSet:(id)object;
+ (BOOL)isLibraryOrderedSet:(id)object;
+ (BOOL)isFoundationOrderedSet:(id)object;
+ (BOOL)isDictionary:(id)object;
+ (BOOL)isLibraryDictionary:(id)object;
+ (BOOL)isFoundationDictionary:(id)object;
+ (BOOL)isStack:(id)object;
+ (BOOL)isQueue:(id)object;
+ (BOOL)isList:(id)object;
+ (BOOL)isSortable:(id)object;

@end