Протокол <SCCollection>

Протокол классов коллекций Подробнее...

#import <SCCollectionProtocols.h>

Граф наследования:<SCCollection>:

Основные свойства коллекций
NSString *	name
SCIndex	count
BOOL	empty
BOOL	readOnly
id< SCCollectionDelegate >	delegate

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

Перечисление коллеций
NSEnumerator *	objectEnumerator
NSEnumerator *	reverseObjectEnumerator
(NSUInteger)	- countByEnumeratingWithState:objects:count:

Определение типов коллекций
SCCollectionType	collectionType
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

Инициализация коллекций
(instancetype)	- initWithCollection:

Поиск объектов коллекции
(BOOL)	- containsObject:
(BOOL)	- containsObjects:
(BOOL)	- containsCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:

Сравнение коллекций
(BOOL)	- isEqualToCollection:

Подробное описание

Протокол классов коллекций

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Начиная с

версии 1.2.0

Объявляет методы, являющиеся обязательными для всех классов и категорий коллекций и не вносящие изменений в коллекции.

Документация метода

- (BOOL) containsAnyObject:		(id< SCCollectioning >)	object
,			NS_REQUIRES_NIL_TERMINATION

Метод определяет наличие в коллекции хотя бы одного объекта из указанного списка.

Аргументы

object	- первый объект из списка
...	- остальные объекты из списка
NS_REQUIRES_NIL_TERMINATION	- завершающий список нулевой указатель nil

Возвращает

YES при наличии в коллекции хотя бы одного объекта из списка и NO в противном случае

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary) и NSSet(SCSet).

- (BOOL) containsAnyObjectFromCollection:

(id< SCCollection >)

collection

Метод определяет наличие в коллекции хотя бы одного объекта из указанной коллекции.

Аргументы

collection

- коллекция с искомыми объектами

Возвращает

YES при наличии в коллекции хотя бы одного объекта из указанной коллекции и NO в противном случае

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary) и NSSet(SCSet).

- (BOOL) containsCollection:

(id< SCCollection >)

collection

Метод определяет наличие в коллекции всех объектов из указанной коллекции.

Аргументы

collection

- коллекция с искомыми объектами

Возвращает

YES при наличии в коллекции всех объектов из указанной коллекции и NO в противном случае

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary) и NSSet(SCSet).

- (BOOL) containsObject:

(id< SCCollectioning >)

object

Метод определяет наличие в коллекции элемента, который соответствует указанному экземпляру класса.

Аргументы

object

- искомый экземпляр класса

Возвращает

YES если элемент присутствует в коллекции и NO в противном случае

Переопределяется в SCCollection и NSDictionary(SCDictionary).

- (BOOL) containsObjects:		(id< SCCollectioning >)	object
,			NS_REQUIRES_NIL_TERMINATION

Метод определяет наличие в коллекции всех объектов из указанного списка.

Аргументы

object	- первый объект из списка
...	- остальные объекты из списка
NS_REQUIRES_NIL_TERMINATION	- завершающий список нулевой указатель nil

Возвращает

YES при наличии в коллекции всех указанным объектов из списка и NO в противном случае

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary) и NSSet(SCSet).

- (NSUInteger) countByEnumeratingWithState:		(NSFastEnumerationState *)	state
objects:		(id *)	objects
count:		(NSUInteger)	count

Метод возвращает ссылку на классический массив объектов, которые отправитель должен обработать и количество объектов в данном массиве.

Аргументы

state	- контекстная информация, которая используется при обработке объектов как гарантия того, что список этих объектов не будет изменен до завершения обработки
objects	- ссылка на классический массив объектов
count	- максимальное количество объектов, которые могут быть помещены в массив

Возвращает

Количество объектов в массиве или 0 как флаг завершения обработки

Начиная с

версии 1.2.5

Переопределяется в SCCollection.

- (instancetype) initWithCollection:

(id< SCCollection >)

collection

Метод инициализирует коллекцию на основании указанной существующей коллекции.

Аргументы

collection

- исходная коллекция

Возвращает

Инициализированная коллекция

Исключения

SCCollectionException

- обнаружена ошибка коллекции

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary), NSSet(SCSet), SCArray, SCOrderedSet, SCDictionary, SCQueue, SCStack, SCSet и SCList.

- (BOOL) isEqualToCollection:

(id< SCCollection >)

collection

Метод определяет соответствие коллекции содержимому указанной коллекции.

Аргументы

collection

- сравниваемая коллекция

Возвращает

YES при соответствии содержимого коллекций и NO в противном случае

Переопределяется в SCCollection, NSOrderedSet(SCOrderedSet), NSArray(SCArray), NSDictionary(SCDictionary) и NSSet(SCSet).

Полный список свойств

- (SCArray*) array

readnonatomicassign

Массив со всеми объектами коллекции

- (SCBidirectionalList*) bidirectionalList

readnonatomicassign

Двунаправленный список со всеми объектами коллекции

- (SCCollectionType) collectionType

readnonatomicassign

Идентификатор типа коллекции

- (SCIndex) count

readnonatomicassign

Количество объектов в коллекции.

- (id<SCCollectionDelegate>) delegate

readnonatomicretain

Объект делегирования коллекции

- (SCDictionary*) dictionary

readnonatomicassign

Словарь со всеми объектами коллекции.

- (BOOL) empty

readnonatomicassign

Свойство определяет наличие в коллекции хотя бы одного объекта

- (NSArray*) foundationArray

readnonatomicassign

Экземпляр класса NSArray со всеми объектами коллекции

- (NSDictionary*) foundationDictionary

readnonatomicassign

Экземпляр класса NSDictionary со всеми объектами коллекции

- (NSOrderedSet*) foundationOrderedSet

readnonatomicassign

Экземпляр класса NSOrderedSet со всеми объектами коллекции

- (NSSet*) foundationSet

readnonatomicassign

Экземпляр класса NSSet со всеми объектами колллекции

- (BOOL) isArray

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к массивам любого вида

- (BOOL) isCollection

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к коллекциям любого вида

- (BOOL) isDictionary

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к словарям любого типа

- (BOOL) isFoundationArray

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стандартным массивам

- (BOOL) isFoundationCollection

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стандартным коллекциям любого вида

- (BOOL) isFoundationDictionary

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стандартным словарям

- (BOOL) isFoundationOrderedSet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стандартным упорядоченным множествам

- (BOOL) isFoundationSet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стандартным неупорядоченным множествам

- (BOOL) isLibraryArray

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к библиотечным массивам

- (BOOL) isLibraryCollection

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к библиотечным коллекциям любого вида

- (BOOL) isLibraryDictionary

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к библиотечным словарям

- (BOOL) isLibraryOrderedSet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к библиотечным упорядоченным множествам

- (BOOL) isLibrarySet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к библиотечным неупорядоченным множествам

- (BOOL) isList

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к спискам.

- (BOOL) isOrderedSet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к упорядоченным множествам любого типа

- (BOOL) isQueue

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к очередям

- (BOOL) isSet

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к неупорядоченным множествам любого типа

- (BOOL) isSortable

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к сортируемым коллекциям

- (BOOL) isStack

readnonatomicassign

Свойство определяет принадлежность экземпляра класса к стекам

- (NSString*) name

readnonatomicretain

Название коллекции

- (NSEnumerator*) objectEnumerator

readnonatomicassign

Счетчик объектов коллекции

- (SCOrderedSet*) orderedSet

readnonatomicassign

Упорядоченное множество со всеми объектами коллекции

- (SCQueue*) queue

readnonatomicassign

Очередь со всеми объектами коллекции

- (BOOL) readOnly

readnonatomicassign

Свойство определяет нахождение коллекции в режиме только для чтения

- (NSEnumerator*) reverseObjectEnumerator

readnonatomicassign

Обратный счетчик объектов коллекции

- (SCSet*) set

readnonatomicassign

Неупорядоченное множество со всеми объектами коллекции

- (SCStack*) stack

readnonatomicassign

Стек со всеми объектами коллекции

- (SCUnidirectionalList*) unidirectionalList

readnonatomicassign

Однонаправленный список со всеми объектами коллекции

---

Объявления и описания членов протокола находятся в файле:

• SCCollectionProtocols.h