Samond Classes Library 1.2.6-STABLE build 219
List of all members
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 (SCL-20060)

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

(instancetype) + sourceExceptionWithName:
 
(instancetype) + sourceException
 

Creating Incorrect Input Stream Exception (SCL-20062)

(instancetype) + exceptionWithInputStream:name:
 
(instancetype) + exceptionWithInputStream:
 

Creating Read Only Exception (SCL-20063)

(instancetype) + readOnlyExceptionWithName:
 
(instancetype) + readOnlyException
 

Creating and Initializing Empty String Exceptions (SCL-20064)

(instancetype) + emptyStringExceptionWithName:
 
(instancetype) + emptyStringException
 

Creating Closed Stream Exception (SCL-20065)

(instancetype) + exceptionWithClosedStream:name:
 
(instancetype) + exceptionWithClosedStream:
 

Creating Unsupported Class Exception (SCL-20066)

(instancetype) + exceptionWithUnsupported:name:
 
(instancetype) + exceptionWithUnsupported:
 

Creating Reading Error Exception (SCL-20067)

(instancetype) + readErrorExceptionWithStream:name:
 
(instancetype) + readErrorExceptionWithStream:
 

Creating Empty Path Exception (SCL-20068)

(instancetype) + emptyPathExceptionWithName:
 
(instancetype) + emptyPathException
 

Creating String Unique Violation Exception (SCL-20069)

(instancetype) + duplicateExceptionWithName:string:index:
 
(instancetype) + duplicateExceptionWithString:index:
 

Creating Incorrect Sorter Exception (SCL-20070)

(instancetype) + sorterExceptionWithName:
 
(instancetype) + sorterException
 

Creating Incorrect Output Stream Exception (SCL-20071)

(instancetype) + exceptionWithOutputStream:name:
 
(instancetype) + exceptionWithOutputStream:
 

Creating Incorrect Index Exception (SCL-20072)

(instancetype) + exceptionWithIndex:name:
 
(instancetype) + exceptionWithIndex:
 

Creating Incorrect Range Exception (SCL-20073)

(instancetype) + exceptionWithRange:name:
 
(instancetype) + exceptionWithRange:
 

Creating Incorrect Index Set Exception (SCL-20074)

(instancetype) + exceptionWithIndexSet:name:
 
(instancetype) + exceptionWithIndexSet:
 

Creating Indexes and Strings Count Exception (SCL-20075)

(instancetype) + exceptionWithIndexesCount:stringsCount:name:
 
(instancetype) + exceptionWithIndexesCount:stringsCount:
 

Creating Intersected Ranges Exception (SCL-20076)

(instancetype) + exceptionWithRange:intersected:name:
 
(instancetype) + exceptionWithRange:intersected:
 

Creating Writing Exception (SCL-20077)

(instancetype) + writeErrorExceptionWithStream:name:
 
(instancetype) + writeErrorExceptionWithStream:
 

Additional Inherited Members

- Instance Methods inherited from SCException
- Properties inherited from SCException
SCInteger code
 
NSString * eid
 

Detailed Description

Exception class SCTextException.

SDK
macOS 10.6+, iOS 7.0+, GNUstep
Since
version 1.1.4

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

Method Documentation

+ (instancetype) 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- the name of the text instance
string- the duplicating string
index- the index of an existing string
Returns
A created exception
+ (instancetype) 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- the duplicating string
index- the index of an existing string
Returns
A created exception
+ (instancetype) emptyPathException

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

Returns
A created exception
+ (instancetype) emptyPathExceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
Returns
A created exception
+ (instancetype) emptyStringException

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

Returns
A created exception
+ (instancetype) emptyStringExceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
Returns
A created exception
+ (instancetype) exception

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

Returns
A created exception
+ (instancetype) exceptionWithClosedStream: (SCStream *)  stream

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

Parameters
stream- the closed stream
Returns
A created exception
+ (instancetype) 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- the closed stream
name- the name of a text file
Returns
A created exception
+ (instancetype) exceptionWithIndex: (SCIndex)  index

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

Parameters
index- the incorrect index
Returns
A created exception
+ (instancetype) 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- the incorrect index
name- the name of the text instance
Returns
A created exception
+ (instancetype) 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- the number of indexes
scount- the number of strings
Returns
A created exception
+ (instancetype) 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- the number of indexes
scount- the number of strings
name- the name of the text instance
Returns
A created exception
+ (instancetype) exceptionWithIndexSet: (NSIndexSet *)  indexSet

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

Parameters
indexSet- the incorrect index set
Returns
A created exception
+ (instancetype) 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- the incorrect index set
name- the name of the text instance
Returns
A created exception
+ (instancetype) exceptionWithInputStream: (SCStream *)  stream

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

Parameters
stream- the incorrect input stream
Returns
A created exception
+ (instancetype) 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- the incorrect input stream
name- the name of the text file
Returns
A created exception
+ (instancetype) exceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
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 text instance name, error description, error code and error ID.

Parameters
name- the text intance name
reason- the error description
code- the error code
eid- the error ID
Returns
A created exception
+ (instancetype) exceptionWithOutputStream: (SCStream *)  stream

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

Parameters
stream- the incorrect output stream
Returns
A created exception
+ (instancetype) 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- the incorrect output stream
name- the name of a text file
Returns
A created exception
+ (instancetype) exceptionWithRange: (NSRange)  range

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

Parameters
range- the incorrect range of strings
Returns
A created exception
+ (instancetype) exceptionWithRange: (NSRange)  range
intersected: (NSRange)  intersected 

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

Parameters
range- the first intersected range
intersected- the second intersected range
Returns
A created exception
+ (instancetype) 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- the first intersected range
intersected- the second intersected range
name- the name of the text instance
Returns
A created exception
+ (instancetype) 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- the incorrect range of strings
name- the name of the text instance
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- the error description
code- the error code
eid- the error ID
Returns
A created exception
+ (instancetype) exceptionWithUnsupported: (NSString *)  unsupported

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

Parameters
unsupported- the name of the unsupported class
Returns
A created exception
+ (instancetype) 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- the name of the unsupported class
name- the text instance name
Returns
A created exception
- (instancetype) 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- the text instance name
reason- the error description
code- the error code
eid- the 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- the error description
code- the error code
eid- the error ID
Returns
A newly initialized exception
+ (instancetype) readErrorExceptionWithStream: (SCStream *)  stream

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

Parameters
stream- the erroneous stream
Returns
A created exception
+ (instancetype) 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- the erroneous stream
name- the name of the text instance
Returns
A created exception
+ (instancetype) readOnlyException

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

Returns
A created exception
+ (instancetype) readOnlyExceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
Returns
A created exception
+ (instancetype) sorterException

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

Returns
A created exception
+ (instancetype) sorterExceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
Returns
A created exception
+ (instancetype) sourceException

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

Returns
A created exception
+ (instancetype) sourceExceptionWithName: (NSString *)  name

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

Parameters
name- the name of the text instance
Returns
A created exception
+ (instancetype) writeErrorExceptionWithStream: (SCStream *)  stream

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

Parameters
stream- the erroneous output stream
Returns
A created exception
+ (instancetype) 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- the erroneous output stream
name- the name of the text file
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
readnonatomicretain

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:
Generated on Fri Aug 10 2018 16:06:37 for Samond Classes Library 1.2.6-STABLE build 219 by   doxygen 1.8.9.1