SCCollection.h

Go to the documentation of this file.

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

#import <scl/SCObject.h>
#import <scl/SCMutableCollection.h>

#pragma mark -
#pragma mark Константы класса

#define SCCollectionClass   @"SCCollection" 
#define SCNotFound          NSNotFound      

@protocol SCCollectionDelegate;

@interface SCCollection : SCObject <SCMutableCollection> {
    NSString                    *fName;     // Название коллекции
    BOOL                         fReadOnly; // Флаг нахождения коллекции в режиме только для чтения
    id<SCCollectionDelegate>     fDelegate; // Указатель на обработчик событий коллекции
}
#pragma mark -
#pragma mark Свойства экземпляра класса

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

@property (nonatomic, assign, getter=readOnly, setter=setReadOnly:) BOOL readOnly;

@property (nonatomic, assign, getter=delegate, setter=setDelegate:) id<SCCollectionDelegate> delegate;

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

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

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

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

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

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

#pragma mark -
#pragma mark Инициализация коллекций
- (id)initWithCollection:(id)collection;

#pragma mark -
#pragma mark Свойства экземпляра класса
- (NSString *)name;
- (BOOL)readOnly;
- (id<SCCollectionDelegate>)delegate;
- (SCULong)count;
- (BOOL)empty;
- (NSString *)typeName;
- (void)setName:(NSString *)name;
- (void)setReadOnly:(BOOL)flag;
- (void)setDelegate:(id<SCCollectionDelegate>)delegate;

#pragma mark -
#pragma mark Копирование коллекций
- (void)setCollection:(id)collection;
- (void)setObject:(id)object;
- (void)setObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Сравнение коллекций
- (BOOL)isEqualToCollection:(id)collection;
- (BOOL)isEqualToContentsOfCollection:(id)collection;
- (BOOL)isEqual:(id)object;

#pragma mark -
#pragma mark Счетчики объектов
- (NSEnumerator *)objectEnumerator;
- (NSEnumerator *)reverseObjectEnumerator;
- (void)enumerateWithDelegate:(id<SCCollectionDelegate>)delegate;
- (void)enumerate;
- (void)reverseEnumerateWithDelegate:(id<SCCollectionDelegate>)delegate;
- (void)reverseEnumerate;

#pragma mark -
#pragma mark Преобразование коллекций
- (SCArray *)array;
- (SCSet *)set;
- (SCOrderedSet *)orderedSet;
- (SCDictionary *)dictionary;
- (SCStack *)stack;
- (SCQueue *)queue;
- (SCUnidirectionalList *)unidirectionalList;
- (SCBidirectionalList *)bidirectionalList;
- (NSArray *)foundationArray;
- (NSSet *)foundationSet;
- (NSOrderedSet *)foundationOrderedSet;
- (NSDictionary *)foundationDictionary;

#pragma mark -
#pragma mark Добавление объктов
- (void)addObject:(id)object;
- (void)addObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)addByte:(SCByte)value;
- (void)addUByte:(SCUByte)value;
- (void)addShort:(SCShort)value;
- (void)addUShort:(SCUShort)value;
- (void)addInteger:(SCInteger)value;
- (void)addUInteger:(SCUInteger)value;
- (void)addLong:(SCLong)value;
- (void)addULong:(SCULong)value;
- (void)addChar:(char)value;
- (void)addUnichar:(unichar)value;
- (void)addCharString:(const char *)string;
- (void)addBool:(BOOL)value;
- (void)addFloat:(SCFloat)value;
- (void)addDouble:(SCDouble)value;
- (void)addCollection:(id)collection;

#pragma mark -
#pragma mark Удаление объектов
- (void)removeAllObjects;
- (void)removeObjectsWithClass:(Class)oclass;
- (void)removeObjectsWithClassName:(NSString *)name;
- (void)removeCollection:(id)collection;
- (void)removeObject:(id)object;
- (void)removeByte:(SCByte)value;
- (void)removeUByte:(SCUByte)value;
- (void)removeShort:(SCShort)value;
- (void)removeUShort:(SCUShort)value;
- (void)removeInteger:(SCInteger)value;
- (void)removeUInteger:(SCUInteger)value;
- (void)removeLong:(SCLong)value;
- (void)removeULong:(SCULong)value;
- (void)removeChar:(char)value;
- (void)removeUnichar:(unichar)value;
- (void)removeCharString:(const char *)string;
- (void)removeBool:(BOOL)value;
- (void)removeFloat:(SCFloat)value;
- (void)removeDouble:(SCDouble)value;
- (void)removeObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;

#pragma mark -
#pragma mark Поиск объектов
- (BOOL)containsObject:(id)object;
- (BOOL)containsByte:(SCByte)value;
- (BOOL)containsUByte:(SCUByte)value;
- (BOOL)containsShort:(SCShort)value;
- (BOOL)containsUShort:(SCUShort)value;
- (BOOL)containsInteger:(SCInteger)value;
- (BOOL)containsUInteger:(SCUInteger)value;
- (BOOL)containsLong:(SCLong)value;
- (BOOL)containsULong:(SCULong)value;
- (BOOL)containsChar:(char)value;
- (BOOL)containsUnichar:(unichar)value;
- (BOOL)containsCharString:(const char *)string;
- (BOOL)containsBool:(BOOL)value;
- (BOOL)containsFloat:(SCFloat)value;
- (BOOL)containsDouble:(SCDouble)value;
- (BOOL)containsObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsCollection:(id)collection;
- (BOOL)containsAnyObject:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (BOOL)containsAnyObjectFromCollection:(id)collection;

#pragma mark -
#pragma mark Определение типов коллекций
+ (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;

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

@end