SCTextException Class Reference

Exception class SCTextException. More...

#import <SCTextException.h>

Inheritance diagram for SCTextException:

Instance Properties
NSString *	textName
NSString *	string
SCIndex	index
NSIndexSet *	indexSet
NSString *	unsupported
SCULong	indexesCount
SCULong	stringsCount
NSRange	range
NSRange	intersected
SCStream *	stream

Creating and Initializing the Generic Text Exceptions
(id)	- initWithName:reason:code:eid:
(id)	- initWithReason:code:eid:
(id)	- initWithName:
(id)	- init
(SCTextException *)	+ exceptionWithName:reason:code:eid:
(SCTextException *)	+ exceptionWithReason:code:eid:
(SCTextException *)	+ exceptionWithName:
(SCTextException *)	+ exception

Creating and Initializing Source Exception
(id)	- initSourceExceptionWithName:
(id)	- initSourceException
(SCTextException *)	+ sourceExceptionWithName:
(SCTextException *)	+ sourceException

Creating and Initializing Incorrect Input Stream Exception
(id)	- initWithInputStream:name:
(id)	- initWithInputStream:
(SCTextException *)	+ exceptionWithInputStream:name:
(SCTextException *)	+ exceptionWithInputStream:

Creating and Initialzing Read Only Exception
(id)	- initReadOnlyWithName:
(id)	- initReadOnly
(SCTextException *)	+ readOnlyExceptionWithName:
(SCTextException *)	+ readOnlyException

Creating and Initializing Empty String Exceptions
(id)	- initEmptyStringWithName:
(id)	- initEmptyString
(SCTextException *)	+ emptyStringExceptionWithName:
(SCTextException *)	+ emptyStringException

Creating and Initializing Closed Stream Exception
(id)	- initWithClosedStream:name:
(id)	- initWithClosedStream:
(SCTextException *)	+ exceptionWithClosedStream:name:
(SCTextException *)	+ exceptionWithClosedStream:

Creating and Initializing Unsupported Class Exception
(id)	- initWithUnsupported:name:
(id)	- initWithUnsupported:
(SCTextException *)	+ exceptionWithUnsupported:name:
(SCTextException *)	+ exceptionWithUnsupported:

Creating and Initializing Reading Error Exception
(id)	- initReadErrorWithStream:name:
(id)	- initReadErrorWithStream:
(SCTextException *)	+ readErrorExceptionWithStream:name:
(SCTextException *)	+ readErrorExceptionWithStream:

Creating and Initializing Empty Path Exception
(id)	- initEmptyPathExceptionWithName:
(id)	- initEmptyPathException
(SCTextException *)	+ emptyPathExceptionWithName:
(SCTextException *)	+ emptyPathException

Creating and Initializing String Unique Violation Exception
(id)	- initDuplicateWithName:string:index:
(id)	- initDuplicateWithString:index:
(SCTextException *)	+ duplicateExceptionWithName:string:index:
(SCTextException *)	+ duplicateExceptionWithString:index:

Creating and Initializing Incorrect Sorter Exception
(id)	- initSorterExceptionWithName:
(id)	- initSorterException
(SCTextException *)	+ sorterExceptionWithName:
(SCTextException *)	+ sorterException

Creating and Initializing Incorrect Output Stream Exception
(id)	- initWithOutputStream:name:
(id)	- initWithOutputStream:
(SCTextException *)	+ exceptionWithOutputStream:name:
(SCTextException *)	+ exceptionWithOutputStream:

Creating and Initializing Incorrect Index Exception
(id)	- initWithIndex:name:
(id)	- initWithIndex:
(SCTextException *)	+ exceptionWithIndex:name:
(SCTextException *)	+ exceptionWithIndex:

Creating and Initializing Incorrect Range Exception
(id)	- initWithRange:name:
(id)	- initWithRange:
(SCTextException *)	+ exceptionWithRange:name:
(SCTextException *)	+ exceptionWithRange:

Creating and Initializing Incorrect Index Set Exception
(id)	- initWithIndexSet:name:
(id)	- initWithIndexSet:
(SCTextException *)	+ exceptionWithIndexSet:name:
(SCTextException *)	+ exceptionWithIndexSet:

Creating and Initializing Indexes and Strings Count Exception
(id)	- initWithIndexesCount:stringsCount:name:
(id)	- initWithIndexesCount:stringsCount:
(SCTextException *)	+ exceptionWithIndexesCount:stringsCount:name:
(SCTextException *)	+ exceptionWithIndexesCount:stringsCount:

Creating and Initializing Intersected Ranges Exception
(id)	- initWithRange:intersected:name:
(id)	- initWithRange:intersected:
(SCTextException *)	+ exceptionWithRange:intersected:name:
(SCTextException *)	+ exceptionWithRange:intersected:

Creating and Initializing Writing Exception
(id)	- initWriteErrorWithStream:name:
(id)	- initWriteErrorWithStream:
(SCTextException *)	+ writeErrorExceptionWithStream:name:
(SCTextException *)	+ writeErrorExceptionWithStream:

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

Detailed Description

Exception class SCTextException.

Since

version 1.1.4

Declares the text object exceptions.
Generated exceptions correspond to the following errors:

• SCL-20060: unspecified text error
• SCL-20061: source object does not exist
• SCL-20062: incorrect input stream
• SCL-20063: text is read only
• SCL-20064: null string adding
• SCL-20065: closed stream
• SCL-20066: not string instance
• SCL-20067: reading error
• SCL-20068: empty text file path
• SCL-20069: string unique violation
• SCL-20070: incorrect strings sorter
• SCL-20071: incorrect output stream
• SCL-20072: incorrect string index
• SCL-20073: incorrect string range
• SCL-20074: incorrect index set
• SCL-20075: number of indexes does not match number of strings
• SCL-20076: intersected string ranges

Method Documentation

+ (SCTextException *) duplicateExceptionWithName:		(NSString *)	name
string:		(NSString *)	string
index:		(SCIndex)	index

Returns a string unique violation exception SCL-20069 created by using the specified text object name, duplicated string and existing string index.

Parameters

name	- text instance name
string	- duplicated string
index	- existing string index

Returns

A created exception

+ (SCTextException *) duplicateExceptionWithString:		(NSString *)	string
index:		(SCIndex)	index

Returns a string unique violation exception SCL-20069 created by using the specified duplicated string and existing string index.

Parameters

string	- duplicated string
index	- existing string index

Returns

A created exception

+ (SCTextException *) emptyPathException

Returns an empty path exception SCL-20068 created by using the default settings.

Returns

A created exception

+ (SCTextException *) emptyPathExceptionWithName:

(NSString *)

name

Returns an empty path exception SCL-20068 created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

+ (SCTextException *) emptyStringException

Returns an empty string exception SCL-20064 created by using the default settings.

Returns

A created exception

+ (SCTextException *) emptyStringExceptionWithName:

(NSString *)

name

Returns an empty string exception SCL-20064 created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

+ (SCTextException *) exception

Returns a generic text exception created by using the default settings.

Returns

A created exception

+ (SCTextException *) exceptionWithClosedStream:

(SCStream *)

stream

Returns a closed stream exception SCL-20065 created by using the specified closed stream.

Parameters

stream

- closed stream

Returns

A created exception

+ (SCTextException *) exceptionWithClosedStream:		(SCStream *)	stream
name:		(NSString *)	name

Returns a closed stream exception SCL-20065 created by using the specified closed stream and text file name.

Parameters

stream	- closed stream
name	- text file name

Returns

A created exception

+ (SCTextException *) exceptionWithIndex:

(SCIndex)

index

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

Parameters

index

- incorrect index

Returns

A created exception

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

Returns an incorrect index exception SCL-20072 created by using the specified incorrect index and text instance name.

Parameters

index	- incorrect index
name	- text instance name

Returns

A created exception

+ (SCTextException *) exceptionWithIndexesCount:		(SCULong)	icount
stringsCount:		(SCULong)	scount

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

Parameters

icount	- number of indexes
scount	- number of strings

Returns

A created exception

+ (SCTextException *) exceptionWithIndexesCount:		(SCULong)	icount
stringsCount:		(SCULong)	scount
name:		(NSString *)	name

Returns an indexes and strings count exception SCL-20075 created by using the specified number of indexes, number of strings and text instance name.

Parameters

icount	- number of indexes
scount	- number of strings
name	- text instance name

Returns

A created exception

+ (SCTextException *) exceptionWithIndexSet:

(NSIndexSet *)

indexSet

Returns an incorrect index set exception SCL-20074 created by using a given incorrect index set.

Parameters

indexSet

- incorrect index set

Returns

A created exception

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

Returns an incorrect index set exception SCL-20074 created by using the specified incorrect index set and text instance name.

Parameters

indexSet	- incorrect index set
name	- text instance name

Returns

A created exception

+ (SCTextException *) exceptionWithInputStream:

(SCStream *)

stream

Returns an incorrect input stream exception SCL-20062 created by using the specified incorrect input stream.

Parameters

stream

- incorrect input stream

Returns

A created exception

+ (SCTextException *) exceptionWithInputStream:		(SCStream *)	stream
name:		(NSString *)	name

Returns an incorrect input stream exception SCL-20062 created by using the specified incorrect input stream and text file name.

Parameters

stream	- incorrect input stream
name	- text file name

Returns

A created exception

+ (SCTextException *) exceptionWithName:

(NSString *)

name

Returns a generic text exception created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

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

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

Parameters

name	- text intance name
reason	- error description
code	- error code
eid	- error ID

Returns

A created exception

+ (SCTextException *) exceptionWithOutputStream:

(SCStream *)

stream

Returns an incorrect output stream exception SCL-20071 created by usinf the specified incorrect output stream.

Parameters

stream

- incorrect output stream

Returns

A created exception

+ (SCTextException *) exceptionWithOutputStream:		(SCStream *)	stream
name:		(NSString *)	name

Returns an incorrect output stream exception SCL-20071 created by using the specified incorrect output stream and text file name.

Parameters

stream	- incorrect output stream
name	- text file name

Returns

A created exception

+ (SCTextException *) exceptionWithRange:

(NSRange)

range

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

Parameters

range

- incorrect string range

Returns

A created exception

+ (SCTextException *) exceptionWithRange:		(NSRange)	range
intersected:		(NSRange)	intersected

Returns an intersected ranges exception SCL-20076 created by using the specified intersected ranges.

Parameters

range	- first intersected range
intersected	- second intersected range

Returns

A created exception

+ (SCTextException *) exceptionWithRange:		(NSRange)	range
intersected:		(NSRange)	intersected
name:		(NSString *)	name

Returns an intersected ranges exception SCL-20076 created by using the specified intersected ranges and text instance name.

Parameters

range	- first intersected range
intersected	- second intersected range
name	- text instance name

Returns

A created exception

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

Returns an incorrect range exception SCL-20073 created by using the specified incorrect string range and text instance name.

Parameters

range	- incorrect string range
name	- text instance name

Returns

A created exception

+ (SCTextException *) 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

+ (SCTextException *) exceptionWithUnsupported:

(NSString *)

unsupported

Returns an unsupported class exception SCL-20066 created by using the specified unsupported class name.

Parameters

unsupported

- unsupported class name

Returns

A created exception

+ (SCTextException *) exceptionWithUnsupported:		(NSString *)	unsupported
name:		(NSString *)	name

Returns an unsupported class exception SCL-20066 created by using the specified unsupported class name and text instance name.

Parameters

unsupported	- unsupported class name
name	- text instance name

Returns

A created exception

- (id) init

Initializes a generic text exception using the default settings.

Returns

A newly initialized exception

- (id) initDuplicateWithName:		(NSString *)	name
string:		(NSString *)	string
index:		(SCIndex)	index

Initializes a string unique violation exception SCL-20069 using the specified text instance name, duplicated string and existing string index.

Parameters

name	- text instance name
string	- duplicated string
index	- existing string index

Returns

A newly initialized exception

- (id) initDuplicateWithString:		(NSString *)	string
index:		(SCIndex)	index

Initializes a string unique violation exception SCL-20069 using the specified duplicates string and existing string index.

Parameters

string	- duplicated string
index	- existing string index

Returns

A newly initialized exception

- (id) initEmptyPathException

Initializes an empty path exception SCL-20068 using the default settings.

Returns

A newly initialized exception

- (id) initEmptyPathExceptionWithName:

(NSString *)

name

Initializes an empty path exception SCL-20068 using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

- (id) initEmptyString

Initializes an empty string exception SCL-20064 using the default settings.

Returns

A newly initialized exception

- (id) initEmptyStringWithName:

(NSString *)

name

Initializes an empty string exception SCL-20064 using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

- (id) initReadErrorWithStream:

(SCStream *)

stream

Initializes a reading error exception SCL-20067 using the specified erroneous stream.

Parameters

stream

- erroneous stream

Returns

A newly initialized exception

- (id) initReadErrorWithStream:		(SCStream *)	stream
name:		(NSString *)	name

Initializes a reading error exception SCL-20067 using the specified erroneous stream and text instance name.

Parameters

stream	- erroneous stream
name	- text instance name

Returns

A newly initialized exception

- (id) initReadOnly

Initializes a read only exception SCL-20063 using the default settings.

Returns

A newly initialized exception

- (id) initReadOnlyWithName:

(NSString *)

name

Initializes a read only exception SCL-20063 using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

- (id) initSorterException

Initializes an incorrect sorter exception SCL-20070 using the default settings.

Returns

A newly initialized exception

- (id) initSorterExceptionWithName:

(NSString *)

name

Initializes an incorrect sorter exception SCL-20070 using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

- (id) initSourceException

Initializes a source exception SCL-20061 using the default settings.

Returns

A newly initialized exception

- (id) initSourceExceptionWithName:

(NSString *)

name

Initializes a source exception SCL-20061 by using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

- (id) initWithClosedStream:

(SCStream *)

stream

Initializes a closed stream exception SCL-20065 using the specified closed stream.

Parameters

stream

- closed stream

Returns

A newly initialized exception

- (id) initWithClosedStream:		(SCStream *)	stream
name:		(NSString *)	name

Initializes a closed stream exception SCL-20065 using the specified closed stream and text file name.

Parameters

stream	- closed stream
name	- text file name

Returns

A newly initialized exception

- (id) initWithIndex:

(SCIndex)

index

Initializes an incorrect index exception SCL-20072 using the specified incorrect index.

Parameters

index

- incorrect index

Returns

A newly initialized exception

- (id) initWithIndex:		(SCIndex)	index
name:		(NSString *)	name

Initializes an incorrect index exception SCL-20072 using the specified incorrect index and text instance name.

Parameters

index	- incorrect index
name	- text instance name

Returns

A newly initialized exception

- (id) initWithIndexesCount:		(SCULong)	icount
stringsCount:		(SCULong)	scount

Initializes an indexes and strings count exception SCL-20075 using the specified number of indexes and number of strings.

Parameters

icount	- number of indexes
scount	- number of strings

Returns

A newly initialized exception

- (id) initWithIndexesCount:		(SCULong)	icount
stringsCount:		(SCULong)	scount
name:		(NSString *)	name

Initializes an indexes and strings count exception SCL-20075 using the specified number of indexes, number of strings and text instance name.

Parameters

icount	- number of indexes
scount	- number of strings
name	- text instance name

Returns

A newly initialized exception

- (id) initWithIndexSet:

(NSIndexSet *)

indexSet

Initializes an incorrect index set exception SCL-20074 using the specified incorrect index set.

Parameters

indexSet

- incorrect index set

Returns

A newly initialized exception

- (id) initWithIndexSet:		(NSIndexSet *)	indexSet
name:		(NSString *)	name

Initializes an incorrect index set exception SCL-20074 using the specified incorrect index set and text instance name.

Parameters

indexSet	- incorrect index set
name	- text instance name

Returns

A newly initialized exception

- (id) initWithInputStream:

(SCStream *)

stream

Initializes an incorrect input stream exception SCL-20062 using the specified incorrect input stream.

Parameters

stream

- incorrect input stream

Returns

A newly initialized exception

- (id) initWithInputStream:		(SCStream *)	stream
name:		(NSString *)	name

Initializes an incorrect input stream exception SCL-20062 using the specified incorrect input stream and text file name.

Parameters

stream	- incorrect input stream
name	- text file name

Returns

A newly initialized exception

- (id) initWithName:

(NSString *)

name

Initializes a generic text exception using the specified text instance name.

Parameters

name	- text instance name

Returns

A newly initialized exception

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

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

Parameters

name	- text instance name
reason	- error description
code	- error code
eid	- error ID

Returns

A newly initialized exception

Reimplemented from SCException.

- (id) initWithOutputStream:

(SCStream *)

stream

Initializes an incorrect output stream exception SCL-20071 using the specified incorrect output stream.

Parameters

stream

- incorrect output stream

Returns

A newly initialized exception

- (id) initWithOutputStream:		(SCStream *)	stream
name:		(NSString *)	name

Initializes an incorrect output stream exception SCL-20071 using the specified incorrect output stream and text file name.

Parameters

stream	- incorrect output stream
name	- text file name

Returns

A newly initialized exception

- (id) initWithRange:

(NSRange)

range

Initializes an incorrect range exception SCL-20073 using the specified incorrect string range.

Parameters

range

- incorrect string range

Returns

A newly initialized exception

- (id) initWithRange:		(NSRange)	range
intersected:		(NSRange)	intersected

Initializes an intersected ranges exception SCL-20076 using the specified intersected ranges.

Parameters

range	- first intersected range
intersected	- second intersected range

Returns

A newly initialized exception

- (id) initWithRange:		(NSRange)	range
intersected:		(NSRange)	intersected
name:		(NSString *)	name

Initializes an intersected ranges exception SCL-20076 using the specified intersected ranges and text instance name.

Parameters

range	- first intersected range
intersected	- second intersected range
name	- text instance name

Returns

A newly initialized exception

- (id) initWithRange:		(NSRange)	range
name:		(NSString *)	name

Initializes an incorrect range exception SCL-20073 using the specified incorrect string range and text instance name.

Parameters

range	- incorrect string range
name	- text instance name

Returns

A newly initialized exception

- (id) 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

- (id) initWithUnsupported:

(NSString *)

unsupported

Initializes an unsupported class exception SCL-20066 using the specified unsupported class name.

Parameters

unsupported

- unsupported class name

Returns

A newly initialized exception

- (id) initWithUnsupported:		(NSString *)	unsupported
name:		(NSString *)	name

Initializes en unsupported class exception SCL-20066 using the specified unsupported class name and text instance name.

Parameters

unsupported	- unsupported class name
name	- text instance name

Returns

A newly initialized exception

- (id) initWriteErrorWithStream:

(SCStream *)

stream

Initializes a writing exception SCL-20077 using the specified erroneous output stream.

Parameters

stream

- erroneous output stream

Returns

A newly initialized exception

- (id) initWriteErrorWithStream:		(SCStream *)	stream
name:		(NSString *)	name

Initializes a writing exception SCL-20077 using the specified erroneous output stream and text file name.

Parameters

stream	- erroneous output stream
name	- text file name

Returns

A newly initialized exception

+ (SCTextException *) readErrorExceptionWithStream:

(SCStream *)

stream

Returns a reading error exception SCL-20067 created by using the specified erroneous stream.

Parameters

stream

- erroneous stream

Returns

A created exception

+ (SCTextException *) readErrorExceptionWithStream:		(SCStream *)	stream
name:		(NSString *)	name

Returns a reading error exception SCL-20067 created by using the specified erroneous stream and text instance name.

Parameters

stream	- erroneous stream
name	- text instance name

Returns

A created exception

+ (SCTextException *) readOnlyException

Returns a read only exception SCL-20063 created by using the default settings.

Returns

A created exception

+ (SCTextException *) readOnlyExceptionWithName:

(NSString *)

name

Returns a read only exception SCL-20063 created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

+ (SCTextException *) sorterException

Returns an incorrect sorter exception SCL-20070 created by using the default settings.

Returns

A created exception

+ (SCTextException *) sorterExceptionWithName:

(NSString *)

name

Returns an incorrect sorter exception SCL-20070 created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

+ (SCTextException *) sourceException

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

Returns

A created exception

+ (SCTextException *) sourceExceptionWithName:

(NSString *)

name

Returns a source exception SCL-20061 created by using the specified text instance name.

Parameters

name	- text instance name

Returns

A created exception

+ (SCTextException *) writeErrorExceptionWithStream:

(SCStream *)

stream

Returns a writing exception SCL-20077 created by using the specified erroneous output stream.

Parameters

stream

- erroneous output stream

Returns

A created exception

+ (SCTextException *) writeErrorExceptionWithStream:		(SCStream *)	stream
name:		(NSString *)	name

Returns a writing exception SCL-20077 created by using the specified erroneous output stream and text file name.

Parameters

stream	- erroneous output stream
name	- text file name

Returns

A created exception

Property Documentation

- (SCIndex) index

readnonatomicassign

Returns the incorrect string index.

- (SCULong) indexesCount

readnonatomicassign

Returns the number of indexes.

- (NSIndexSet *) indexSet

readnonatomicretain

Returns the incorrect index set.

- (NSRange) intersected

readnonatomicassign

Returns the intersected string range.

- (NSRange) range

readnonatomicassign

Returns the incorrect string range.

- (SCStream *) stream

readnonatomicassign

Return the incorrect stream.

- (NSString *) string

readnonatomicretain

Returns the incorrect string.

- (SCULong) stringsCount

readnonatomicassign

Returns the number of strings.

- (NSString *) textName

readnonatomicretain

Returns the erroneous text instance name.

- (NSString *) unsupported

readnonatomicretain

Returns the unsupported class name.

---

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

• SCTextException.h
• SCTextException.m