Протокол <SCCollection>

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

#import <SCCollectionProtocols.h>

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

Основные свойства коллекций
NSString *	name
SCIndex	count
BOOL	empty
NSString *	description

Дополнительные свойства коллекций
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

Доступ к свойствам коллекций
(NSString *)	- name
(void)	- setName:
(SCIndex)	- count
(NSString *)	- description
(BOOL)	- empty
(BOOL)	- readOnly

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

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

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

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

Перечисление коллеций
(NSEnumerator *)	- objectEnumerator
(NSEnumerator *)	- reverseObjectEnumerator

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

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

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Начиная с

версии 1.2.0

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

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

- (SCArray *) array

Метод возвращает массив, который содержит все объекты исходной коллекции.

Возвращает

Массив объктов

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

- (SCBidirectionalList *) bidirectionalList

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

Возвращает

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

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

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

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

Аргументы

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

Возвращает

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

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

- (BOOL) containsAnyObjectFromCollection:

(id< SCCollection >)

collection

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

Аргументы

collection

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

Возвращает

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

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

- (BOOL) containsCollection:

(id< SCCollection >)

collection

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

Аргументы

collection

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

Возвращает

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

Переопределяется в NSOrderedSet(SCOrderedSet), NSArray(SCArray), SCCollection, 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 в противном случае

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

- (SCIndex) count

required

Метод возвращает количество объектов коллекции.

Возвращает

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

- (NSString *) description

required

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

Возвращает

Строка с описанием коллекции

- (SCDictionary *) dictionary

Метод возвращает содержащий все объекты коллекции словарь.

Возвращает

Словарь объектов

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

- (BOOL) empty

required

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

Возвращает

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

- (NSArray *) foundationArray

Метод возвращает содержащий все объекты коллекции стандартный массив.

Возвращает

Стандартный массив объектов

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

- (NSDictionary *) foundationDictionary

Метод возвращает содержащий все объекты коллекции стандартный словарь.

Возвращает

Стандартный словарь объектов

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

- (NSOrderedSet *) foundationOrderedSet

SDK

macOS 10.7+, iOS 7.0+

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

Возвращает

Стандартное упорядоченное множество

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

- (NSSet *) foundationSet

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

Возвращает

Стандартное неупорядоченное множество объектов

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

- (instancetype) initWithCollection:

(id< SCCollection >)

collection

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

Аргументы

collection

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

Возвращает

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

Исключения

SCCollectionException

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

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

- (BOOL) isArray

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

Возвращает

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

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

- (BOOL) isCollection

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

Возвращает

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

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

- (BOOL) isDictionary

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

Возвращает

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

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

- (BOOL) isFoundationArray

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

Возвращает

YES если экземпляр класса является стандартным словарем и NO в противном случае

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

- (BOOL) isFoundationCollection

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

Возвращает

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

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

- (BOOL) isFoundationDictionary

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

Возвращает

YES если экземпляр класса является стандартным словарем и NO в противном случае

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

- (BOOL) isFoundationOrderedSet

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

Возвращает

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

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

- (BOOL) isFoundationSet

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

Возвращает

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

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

- (BOOL) isLibraryArray

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

Возвращает

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

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

- (BOOL) isLibraryCollection

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

Возвращает

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

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

- (BOOL) isLibraryDictionary

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

Возвращает

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

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

- (BOOL) isLibraryOrderedSet

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

Возвращает

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

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

- (BOOL) isLibrarySet

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

Возвращает

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

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

- (BOOL) isList

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

Возвращает

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

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

- (BOOL) isOrderedSet

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

Возвращает

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

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

- (BOOL) isQueue

Метод определяет принадлежность экземпляра класса к очередям.

Возвращает

YES если экземпляр класса является очередью и NO в противном случае

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

- (BOOL) isSet

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

Возвращает

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

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

- (BOOL) isSortable

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

Возвращает

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

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

- (BOOL) isStack

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

Возвращает

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

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

- (NSString *) name

optional

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

Возвращает

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

- (NSEnumerator *) objectEnumerator

Метод возвращает счетчик объектов в коллекции.

Возвращает

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

- (SCOrderedSet *) orderedSet

SDK

macOS 10.7+, iOS 7.0+

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

Возвращает

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

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

- (SCQueue *) queue

Метод возвращает содержащую все объекты коллекции очередь.

Возвращает

Очередь объектов

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

- (BOOL) readOnly

required

Метод определяет нахождение коллекции в режиме только для чтения.

Возвращает

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

- (NSEnumerator *) reverseObjectEnumerator

Метод возвращает обратный счетчик объектов в коллекции.

Возвращает

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

- (SCSet *) set

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

Возвращает

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

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

- (void) setName: (NSString *)  name

optional

Метод устанавливает имя коллекции.

Аргументы

name	- имя коллекции

- (SCStack *) stack

Метод возвращает содержащий все объекты коллекции стек.

Возвращает

Стек объектов

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

- (SCUnidirectionalList *) unidirectionalList

Метод возвращает содержащий все объекты коллекции однонаправленный список.

Возвращает

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

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

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

- (SCArray*) array

readnonatomicretain

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

- (SCBidirectionalList*) bidirectionalList

readnonatomicretain

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

- (SCIndex) count

readrequirednonatomicassign

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

- (NSString*) description

readnonatomicretain

Описание коллекции.

- (SCDictionary*) dictionary

readnonatomicretain

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

- (BOOL) empty

readnonatomicassign

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

- (NSArray*) foundationArray

readnonatomicretain

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

- (NSDictionary*) foundationDictionary

readnonatomicretain

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

- (NSOrderedSet*) foundationOrderedSet

readnonatomicretain

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

SDK

macOS 10.7+, iOS 7.0+.

- (NSSet*) foundationSet

readnonatomicretain

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

- (NSString*) name

readwriteoptionalnonatomicretain

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

- (NSEnumerator*) objectEnumerator

readnonatomicretain

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

- (SCOrderedSet*) orderedSet

readnonatomicretain

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

SDK

macOS 10.7+, iOS 7.0+.

- (SCQueue*) queue

readnonatomicretain

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

- (SCSet*) set

readnonatomicretain

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

- (SCStack*) stack

readnonatomicretain

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

- (SCUnidirectionalList*) unidirectionalList

readnonatomicretain

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

---

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

• SCCollectionProtocols.h