SCCollectionException Class Reference

Exception class SCCollectionException. More...

#import <SCCollectionException.h>

Inheritance diagram for SCCollectionException:

Instance Methods
(instancetype)	- initWithIndexesCount:objectsCount: [implementation]
Instance Methods inherited from SCException

Instance Properties
NSString *	collectionName
NSString *	typeName
NSString *	unsupported
NSString *	unknown
SCIndex	index
NSRange	range
NSIndexSet *	indexSet
SCULong	indexesCount
SCULong	objectsCount
NSString *	key
SCULong	keysCount

Creating and Initializing the Generic Collection Exceptions
(instancetype)	+ exceptionWithName:reason:code:eid:
(instancetype)	+ exceptionWithReason:code:eid:
(instancetype)	+ exceptionWithName:
(instancetype)	+ exception
(instancetype)	- initWithName:reason:code:eid:
(instancetype)	- initWithReason:code:eid:

Creating Source Exception (SCL-20041)
(instancetype)	+ exceptionWithSource

Creating Unsupported Collection Type Exception (SCL-20042)
(instancetype)	+ exceptionWithUnsupportedType:

Creating Read Only Exception (SCL-20043)
(instancetype)	+ exceptionWithReadOnlyType:name:
(instancetype)	+ exceptionWithReadOnlyType:

Creating Null Object Exception (SCL-20044)
(instancetype)	+ exceptionWithItemType:name:
(instancetype)	+ exceptionWithItemType:

Creating Source Object Exception (SCL-20045)
(instancetype)	+ exceptionWithObject

Creating Unsupported Class Exception (SCL-20046)
(instancetype)	+ exceptionWithUnsupported:type:name:
(instancetype)	+ exceptionWithUnsupported:type:

Creating Unknown Class Exception (SCL-20047)
(instancetype)	+ exceptionWithUnknown:type:name:
(instancetype)	+ exceptionWithUnknown:type:

Creating Incomparable Object Exception (SCL-20048)
(instancetype)	+ exceptionWithNotComparableType:name:
(instancetype)	+ exceptionWithNotComparableType:

Creating Unsortable Collection Exception (SCL-20049)
(instancetype)	+ exceptionWithNotSortableType:name:
(instancetype)	+ exceptionWithNotSortableType:

Creating Incorrect Sorter Exception (SCL-20050)
(instancetype)	+ exceptionWithSorterType:name:
(instancetype)	+ exceptionWithSorterType:

Creating Incorrect Index Exception (SCL-20052)
(instancetype)	+ exceptionWithIndex:name:
(instancetype)	+ exceptionWithIndex:

Creating Incorrect Range Exception (SCL-20053)
(instancetype)	+ exceptionWithRange:name:
(instancetype)	+ exceptionWithRange:

Creating Incorrect Index Set Exception (SCL-20054)
(instancetype)	+ exceptionWithIndexSet:name:
(instancetype)	+ exceptionWithIndexSet:

Creating Indexes and Objects Count Exception (SCL-20055)
(instancetype)	+ exceptionWithIndexesCount:objectsCount:

Creating Incorrect Key Exception (SCL-20056)
(instancetype)	+ exceptionWithKey:name:
(instancetype)	+ exceptionWithKey:

Creating Keys and Objects Count Exception (SCL-20057)
(instancetype)	+ exceptionWithKeysCount:objectsCount:

Creating and Initializing Empty Value Exception (SCL-20058)
(instancetype)	+ exceptionValueForKey:name:
(instancetype)	+ exceptionValueForKey:

Additional Inherited Members
Properties inherited from SCException
SCInteger	code
NSString *	eid

Detailed Description

Exception class SCCollectionException.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Declares the collection exceptions.
Generated exceptions correspond to the following errors:

• SCL-20040: unspecified collection error
• SCL-20041: source collection does not exist
• SCL-20042: unsupported collection type
• SCL-20043: collection is read-only
• SCL-20044: adding a null pointer
• SCL-20045: source object does not exist
• SCL-20046: unsupported class
• SCL-20047: unknown class
• SCL-20048: incomparable collection object
• SCL-20049: collection does not support sorting
• SCL-20050: incorrect data sorter
• SCL-20052: incorrect index
• SCL-20053: incorrect objects range
• SCL-20054: incorrect index set
• SCL-20055: number of indexes does not match number of objects
• SCL-20056: incorrect object key
• SCL-20057: number of keys does not match number of objects
• SCL-20058: empty value

Method Documentation

+ (instancetype) exception

Returns a generic collection exception SCL-20040 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionValueForKey:

(NSString *)

key

Returns an empty value exception SCL-20058 created by using the specified key.

Parameters

key	- value key

Returns

A created exception

+ (instancetype) exceptionValueForKey:		(NSString *)	key
name:		(NSString *)	name

Returns an empty value exception SCL-20058 created by using the specified key and collection name.

Parameters

key	- value key
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithIndex:

(SCIndex)

index

Returns an incorrect index exception SCL-20052 created by using the specified incorrect index.

Parameters

index

- incorrect index

Returns

A created exception

+ (instancetype) exceptionWithIndex:		(SCIndex)	index
name:		(NSString *)	name

Returns an incorrect index exception SCL-20052 created by using the specified incorrect index and collection name.

Parameters

index	- incorrect index
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithIndexesCount:		(SCULong)	indexes
objectsCount:		(SCULong)	objects

Returns an indexes and objects count exception SCL-20055 created by using the specified number of indexes and number of objects.

Parameters

indexes	- number of indexes
objects	- number of objects

Returns

A created exception

+ (instancetype) exceptionWithIndexSet:

(NSIndexSet *)

indexSet

Returns an incorrect index set exception SCL-20054 created by using the specified index set.

Parameters

indexSet

- incorrect index set

Returns

A created exception

+ (instancetype) exceptionWithIndexSet:		(NSIndexSet *)	indexSet
name:		(NSString *)	name

Returns an incorrect index set exception SCL-20054 created by using the specified index set and collection name.

Parameters

indexSet	- incorrect index set
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithItemType:

(NSString *)

type

Returns a null object exception SCL-20044 created by using the specified collection type.

Parameters

type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithItemType:		(NSString *)	type
name:		(NSString *)	name

Returns a null object exception SCL-20044 created by using the specified collection type and collection name.

Parameters

type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithKey:

(NSString *)

key

Returns an incorrect key exception SCL-20056 created by using the specified incorrect key.

Parameters

key	- incorrect object key

Returns

A created exception

+ (instancetype) exceptionWithKey:		(NSString *)	key
name:		(NSString *)	name

Returns an incorrect key exception SCL-20056 created by using the specified incorrect key and collection name.

Parameters

key	- incorrect object key
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithKeysCount:		(SCULong)	keys
objectsCount:		(SCULong)	objects

Returns a keys and objects count exception SCL-20057 created by using the specified number of keys and number of objects.

Parameters

keys	- number of keys
objects	- number of objects

Returns

A created exception

+ (instancetype) exceptionWithName:

(NSString *)

name

Returns a generic collection exception SCL-20040 created by using the specified collection name.

Parameters

name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithName:		(NSString *)	name
reason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

Returns an exception created by using the specified collection name, error description, error code and error ID.

Parameters

name	- collection name
reason	- error description
code	- error code
eid	- error ID

Returns

A created exception

+ (instancetype) exceptionWithNotComparableType:

(NSString *)

type

Returns an incomparable object exception SCL-20048 created by using the specified collection type.

Parameters

type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithNotComparableType:		(NSString *)	type
name:		(NSString *)	name

Returns an incomparable object exception SCL-20048 created by using the specified collection type and collection name.

Parameters

type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithNotSortableType:

(NSString *)

type

Returns an unsortable collection exception SCL-20049 created by using the specified collection type.

Parameters

type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithNotSortableType:		(NSString *)	type
name:		(NSString *)	name

Returns an unsortable collection exception SCL-20049 created by using the specified collection type and collection name.

Parameters

type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithObject

Returns a source object exception SCL-20045 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithRange:

(NSRange)

range

Returns an incorrect range exception SCL-20053 created by using the specified incorrect range.

Parameters

range

- incorrect range

Returns

A created exception

+ (instancetype) exceptionWithRange:		(NSRange)	range
name:		(NSString *)	name

Returns an incorrect range exception SCL-20053 created by using the specified incorrect range and collection name.

Parameters

range	- incorrect range
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithReadOnlyType:

(NSString *)

type

Returns a read only exception SCL-20043 created by using the specified collection type.

Parameters

type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithReadOnlyType:		(NSString *)	type
name:		(NSString *)	name

Returns a read only exception SCL-20043 created by using the specified collection type and collection name.

Parameters

type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithReason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

Returns an exception created by using the specified error description, error code and error ID.

Parameters

reason	- error description
code	- error code
eid	- error ID

Returns

A created exception

+ (instancetype) exceptionWithSorterType:

(NSString *)

type

Returns an incorrect sorter exception SCL-20050 created by using the specified collection type.

Parameters

type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithSorterType:		(NSString *)	type
name:		(NSString *)	name

Returns an incorrect sorter exception SCL-20050 created by using the specified collection type and collection name.

Parameters

type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithSource

Returns a source exception SCL-20041 created by using the defult settings.

Returns

A created exception

+ (instancetype) exceptionWithUnknown:		(NSString *)	cname
type:		(NSString *)	type

Returns an unknown class exception SCL-20047 created by using the specified unknown class name and collection type.

Parameters

cname	- unknown class name
type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithUnknown:		(NSString *)	cname
type:		(NSString *)	type
name:		(NSString *)	name

Returns an unknown class exception SCL-20047 created by using the specified unknown class name, collection type and collection name.

Parameters

cname	- unknown class name
type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithUnsupported:		(NSString *)	cname
type:		(NSString *)	type

Returns an unsupported class exception SCL-20046 created by using the specified unsupported class name and collection type.

Parameters

cname	- unsupported class name
type	- collection type

Returns

A created exception

+ (instancetype) exceptionWithUnsupported:		(NSString *)	cname
type:		(NSString *)	type
name:		(NSString *)	name

Returns an unsupported class exception SCL-20046 created by using the specified unsupported class name, collection type and collection name.

Parameters

cname	- unsupported class name
type	- collection type
name	- collection name

Returns

A created exception

+ (instancetype) exceptionWithUnsupportedType:

(NSString *)

type

Returns an unsupported collection type exception SCL-20042 created by using the specified unsupported type name.

Parameters

type	- unsupported type name

Returns

A created exception

- (instancetype) initWithIndexesCount: (SCULong)  indexes objectsCount: (SCULong)  objects

implementation

Initializes an indexes and objects count exception SCL-20055 created by using the specified number of indexes and number of objects.

Parameters

indexes	- number of indexes
objects	- number of objects

Returns

A newly initialized exception

- (instancetype) initWithName:		(NSString *)	name
reason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

Initializes an exception using the specified collection name, error description, error code and error ID.

Attention

Designed initializer

Parameters

name	- collection name
reason	- error description
code	- error code
eid	- error id

Returns

A newly initialized exception

Reimplemented from SCException.

- (instancetype) initWithReason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

Initializes an exception using the specified error description, error code and error ID.

Parameters

reason	- error description
code	- error code
eid	- error ID

Returns

A newly initialized exception

Property Documentation

- (NSString*) collectionName

readnonatomicretain

Erroneous collection name

- (SCIndex) index

readnonatomicassign

Incorrect object index (SCL-20052)

- (SCULong) indexesCount

readnonatomicassign

Number of indexes (SCL-20055)

- (NSIndexSet*) indexSet

readnonatomicretain

Incorrect index set (SCL-20054)

- (NSString*) key

readnonatomicretain

Incorrect object key (SCL-20056)

- (SCULong) keysCount

readnonatomicassign

Number of keys (SCL-20057)

- (SCULong) objectsCount

readnonatomicassign

Number of objects (SCL-20055 and SCL-20057)

- (NSRange) range

readnonatomicassign

Incorrect objects range (SCL-20053)

- (NSString*) typeName

readnonatomicretain

Unsupported collection type name (SCL-20042)

- (NSString*) unknown

readnonatomicretain

Unknown class name (SCL-20047)

- (NSString*) unsupported

readnonatomicretain

Unsupported class name (SCL-20046)

---

The documentation for this class was generated from the following files:

• SCCollectionException.h
• SCCollectionException.m