<SCIndexedCollection> Protocol Reference

Indexed collections protocol. More...

#import <SCCollectionProtocols.h>

Inheritance diagram for <SCIndexedCollection>:

Querying a Collection
id	firstObject
id	lastObject
(id)	- objectAtIndex:
(id)	- objectAtIndexedSubscript:

Finding Objects in a Collection
SCIndex	indexOfLastObject
(SCIndex)	- indexOfObject:

Additional Inherited Members
Instance Methods inherited from <SCCollection>
(NSUInteger)	- countByEnumeratingWithState:objects:count:
(instancetype)	- initWithCollection:
(BOOL)	- containsObject:
(BOOL)	- containsObjects:
(BOOL)	- containsCollection:
(BOOL)	- containsAnyObject:
(BOOL)	- containsAnyObjectFromCollection:
(BOOL)	- isEqualToCollection:
Properties inherited from <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
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

Detailed Description

Indexed collections protocol.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.2.0

Declares the mandatory methods for support indexed collections.

Method Documentation

- (SCIndex) indexOfObject:

(id< SCCollectioning >)

object

Returns the lowest index whose corresponding collection value is equal to a given object.

Parameters

object

- desired object

Returns

Index of object that equals to the specified object, otherwise SCNotFound

Reimplemented in SCArray, and SCOrderedSet.

- (id) objectAtIndex:

(SCIndex)

index

Returns the object located at the specified index.

Parameters

index

- required object index

Returns

Object at the specified index

Exceptions

SCCollectionException

- collection error detected

Reimplemented in SCArray, and SCOrderedSet.

- (id) objectAtIndexedSubscript:

(SCIndex)

index

Returns the object at the specified index.

Parameters

index

- the index within the bounds of the indexes collection

Returns

The object located at a given index

Exceptions

SCCollectionException

- collection error detected

Since

version 1.2.5

Reimplemented in SCArray, and SCOrderedSet.

Property Documentation

- (id) firstObject

readnonatomicassign

The first object from the receiving collection

- (SCIndex) indexOfLastObject

readnonatomicassign

An index of the last object within the collection

- (id) lastObject

readnonatomicassign

The last object from the receiving collection

---

The documentation for this protocol was generated from the following file:

• SCCollectionProtocols.h