SCCollectionProtocols.h

См. документацию.

//
//  SCCollectionProtocols.h
//  scl
//
//  Created by Viacheslav Smolensky on 09.03.17.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCTypes.h>

@class SCArray;
@class SCSet;
#ifndef GNUSTEP
@class SCOrderedSet;
#endif
@class SCDictionary;
@class SCStack;
@class SCQueue;
@class SCUnidirectionalList;
@class SCBidirectionalList;

#pragma mark -
#pragma mark Protocol SCCollection Declaration

@protocol SCCollection

#pragma mark -
#pragma mark Primary Collection Properties

@optional
@property (nonatomic, retain, getter=name, setter=setName:) NSString *name;

@required
@property (nonatomic, assign, readonly, getter=count) SCIndex count;

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

@property (nonatomic, retain, readonly, getter=description) NSString *description;

#pragma mark -
#pragma mark Additional Collection Properties

@property (nonatomic, retain, readonly, getter=array) SCArray *array;

@property (nonatomic, retain, readonly, getter=set) SCSet *set;

#ifndef GNUSTEP
@property (nonatomic, retain, readonly, getter=orderedSet) SCOrderedSet *orderedSet;
#endif

@property (nonatomic, retain, readonly, getter=dictionary) SCDictionary *dictionary;

@property (nonatomic, retain, readonly, getter=stack) SCStack *stack;

@property (nonatomic, retain, readonly, getter=queue) SCQueue *queue;

@property (nonatomic, retain, readonly, getter=unidirectionalList) SCUnidirectionalList *unidirectionalList;

@property (nonatomic, retain, readonly, getter=bidirectionalList) SCBidirectionalList *bidirectionalList;

@property (nonatomic, retain, readonly, getter=foundationArray) NSArray *foundationArray;

@property (nonatomic, retain, readonly, getter=foundationSet) NSSet *foundationSet;

#ifndef GNUSTEP
@property (nonatomic, retain, readonly, getter=foundationOrderedSet) NSOrderedSet *foundationOrderedSet;
#endif

@property (nonatomic, retain, readonly, getter=foundationDictionary) NSDictionary *foundationDictionary;

@property (nonatomic, retain, readonly, getter=objectEnumerator) NSEnumerator *objectEnumerator;


#pragma mark -
#pragma mark Accessing Collection Properties

@optional
- (NSString *)name;

- (void)setName:(NSString *)name;

@required
- (SCIndex)count;

- (NSString *)description;

- (BOOL)empty;

- (BOOL)readOnly;

#pragma mark -
#pragma mark Initializing Collections

- (instancetype)initWithCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Поиск объектов коллекции

- (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 Converting Collections

- (SCArray *)array;

- (SCSet *)set;

#ifndef GNUSTEP
- (SCOrderedSet *)orderedSet;
#endif

- (SCDictionary *)dictionary;

- (SCStack *)stack;

- (SCQueue *)queue;

- (SCUnidirectionalList *)unidirectionalList;

- (SCBidirectionalList *)bidirectionalList;

- (NSArray *)foundationArray;

- (NSSet *)foundationSet;

#ifndef GNUSTEP
- (NSOrderedSet *)foundationOrderedSet;
#endif

- (NSDictionary *)foundationDictionary;

#pragma mark -
#pragma mark Detecting Collection Type

- (BOOL)isCollection;

- (BOOL)isLibraryCollection;

- (BOOL)isFoundationCollection;

- (BOOL)isArray;

- (BOOL)isLibraryArray;

- (BOOL)isFoundationArray;

- (BOOL)isSet;

- (BOOL)isLibrarySet;

- (BOOL)isFoundationSet;

- (BOOL)isOrderedSet;

- (BOOL)isLibraryOrderedSet;

- (BOOL)isFoundationOrderedSet;

- (BOOL)isDictionary;

- (BOOL)isLibraryDictionary;

- (BOOL)isFoundationDictionary;

- (BOOL)isStack;

- (BOOL)isQueue;

- (BOOL)isList;

- (BOOL)isSortable;

@optional
#pragma mark -
#pragma mark Objects Enumerators

- (NSEnumerator *)objectEnumerator;

- (NSEnumerator *)reverseObjectEnumerator;

@end

#pragma mark -
#pragma mark Protocol SCMutableCollection Declaration

@protocol SCMutableCollection <SCCollection>

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

@end

#pragma mark -
#pragma mark Protocol SCIndexedCollection Declaration

@protocol SCIndexedCollection <SCCollection>

#pragma mark -
#pragma mark Querying a Collection

- (id)firstObject;

- (id)lastObject;

- (id)objectAtIndex:(SCIndex)index;

#pragma mark -
#pragma mark Finding Objects in a Collection

- (SCIndex)indexOfObject:(id<SCCollectioning>)object;

- (SCIndex)indexOfLastObject;

@end

#pragma mark -
#pragma mark Protocol SCMutableIndexedCollection Declaration

@protocol SCMutableIndexedCollection <SCIndexedCollection>

#pragma mark -
#pragma mark Adding Objects

- (void)insertObject:(id<SCCollectioning>)object atIndex:(SCIndex)index;

#pragma mark -
#pragma mark Removing Objects

- (void)removeObjectAtIndex:(SCIndex)index;

- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes;

#pragma mark -
#pragma mark Replacing Objects

- (void)replaceObjectAtIndex:(SCIndex)index withObject:(id<SCCollectioning>)object;

@end