NSArray+SCArray.h

Go to the documentation of this file.

//
//  NSArray+SCArray.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.05.12.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/NSObject+SCObject.h>
#import <scl/SCCollectionProtocols.h>
#import <scl/SCSorter.h>

#pragma mark -
#pragma mark Class Constants

#define NSArrayClass @"NSArray"


@interface NSArray(SCArray) <SCCollection, SCIndexedCollection>

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

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

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

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

@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;

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

@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) NSArray *reversedArray;

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

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

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

#pragma mark -
#pragma mark Creating Arrays
+ (instancetype)arrayWithCoder:(NSCoder *)coder;
+ (instancetype)arrayWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)arrayWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)arrayWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)arrayWithStream:(SCStream *)stream;
+ (instancetype)arrayWithFileStream:(NSString *)path;
+ (instancetype)arrayWithData:(NSData *)data;
+ (instancetype)arrayWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)arrayWithAscendingSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
+ (instancetype)arrayWithDescendingSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
+ (instancetype)arrayWithSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
+ (instancetype)arrayWithAscendingSortedCollection:(id<SCCollection>)collection;
+ (instancetype)arrayWithDescendingSortedCollection:(id<SCCollection>)collection;
+ (instancetype)arrayWithSortedCollection:(id<SCCollection>)collection;
+ (instancetype)arrayWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Initializing Arrays
- (instancetype)initWithAscendingSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
- (instancetype)initWithDescendingSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
- (instancetype)initWithSortedCollection:(id<SCCollection>)collection sorter:(id<SCSorter>)sorter;
- (instancetype)initWithAscendingSortedCollection:(id<SCCollection>)collection;
- (instancetype)initWithDescendingSortedCollection:(id<SCCollection>)collection;
- (instancetype)initWithSortedCollection:(id<SCCollection>)collection;
- (instancetype)initWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Finding Objects in an Array
- (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 Sorting Arrays
- (NSArray *)ascendingSortedArrayWithSorter:(id<SCSorter>)sorter;
- (NSArray *)descendingSortedArrayWithSorter:(id<SCSorter>)sorter;
- (NSArray *)sortedArrayWithSorter:(id<SCSorter>)sorter;

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

#pragma mark -
#pragma mark Deriving New Arrays
- (NSArray *)arrayByAddingObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (NSArray *)arrayByAddingArray:(NSArray *)array;
- (NSArray *)arrayByAddingCollection:(id<SCCollection>)collection;

@end