SCStreamException Class Reference

Exception class SCStreamException. More...

#import <SCStreamException.h>

Inheritance diagram for SCStreamException:

Instance Properties
NSString *	streamName
NSString *	unknown
NSString *	unexpected
NSString *	expected
NSString *	unsupported
SCSize	readedBytes
SCSize	writedBytes
SCSize	waitedBytes
SCInteger	openError
SCInteger	readError
SCInteger	writeError
NSString *	numberType
SCFileStreamOpenMode	openMode
SCSystemError	seekError
NSInteger	offset
SCFileStreamOffsetWhence	whence

Creating and Initializing the Generic Stream Exceptions (SCL-20020)
(instancetype)	+ exceptionWithStream:reason:code:eid:
(instancetype)	+ exceptionWithReason:code:eid:
(instancetype)	+ exceptionWithStream:
(instancetype)	+ exception
(instancetype)	- initWithStream:reason:code:eid:
(instancetype)	- initWithReason:code:eid:

Creating Not Open Stream Exception (SCL-20021)
(instancetype)	+ exceptionWithNotOpenStream:
(instancetype)	+ exceptionWithNotOpen

Creating Read Only Stream Exception (SCL-20022)
(instancetype)	+ exceptionWithReadOnlyStream:
(instancetype)	+ exceptionWithReadOnly

Creating Write Only Stream Exception (SCL-20023)
(instancetype)	+ exceptionWithWriteOnlyStream:
(instancetype)	+ exceptionWithWriteOnly

Creating Unknown Class Exception (SCL-20024)
(instancetype)	+ exceptionWithUnknown:stream:
(instancetype)	+ exceptionWithUnknown:

Creating Unexpected Class Exception (SCL-20025)
(instancetype)	+ exceptionWithUnexpected:expected:stream:
(instancetype)	+ exceptionWithUnexpected:expected:

Creating Unsupported Class Exception (SCL-20026)
(instancetype)	+ exceptionWithUnsupported:stream:
(instancetype)	+ exceptionWithUnsupported:

Creating Incompleted Operation Exception (SCL-20027 and SCL-20028)
(instancetype)	+ exceptionWithReaded:waited:stream:
(instancetype)	+ exceptionWithReaded:waited:
(instancetype)	+ exceptionWithWrited:waited:stream:
(instancetype)	+ exceptionWithWrited:waited:

Creating Opening Exception (SCL-20029)
(instancetype)	+ exceptionWithOpenError:stream:
(instancetype)	+ exceptionWithOpenError:

Creating Reading Exception (SCL-20030)
(instancetype)	+ exceptionWithReadError:stream:
(instancetype)	+ exceptionWithReadError:

Creating Writing Exception (SCL-20031)
(instancetype)	+ exceptionWithWriteError:stream:
(instancetype)	+ exceptionWithWriteError:

Creating Number Object Exception (SCL-20032)
(instancetype)	+ exceptionWithUnsupportedNumberType:stream:
(instancetype)	+ exceptionWithUnsupportedNumberType:

Creating Incorrect Open Mode Exception (SCL-20033)
(instancetype)	+ exceptionWithOpenMode:path:
(instancetype)	+ exceptionWithOpenMode:

Creating Empty Path Exception (SCL-20034)
(instancetype)	+ exceptionWithEmptyPath

Creating End of Stream Exception (SCL-20035)
(instancetype)	+ exceptionWithEndOfFile:
(instancetype)	+ exceptionWithEndOfFile

Creating Offset Exception (SCL-20036 and SCL-20037)
(instancetype)	+ exceptionWithSeekError:whence:offset:path:
(instancetype)	+ exceptionWithSeekError:whence:offset:
(instancetype)	+ exceptionWithSeekError:path:
(instancetype)	+ exceptionWithSeekError:
(instancetype)	+ exceptionWithWhence:path:
(instancetype)	+ exceptionWithWhence:

Additional Inherited Members
Instance Methods inherited from SCException
(instancetype)	- initWithName:reason:code:eid:
Properties inherited from SCException
SCInteger	code
NSString *	eid

Detailed Description

Exception class SCStreamException.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.1.3

Declares the stream common exceptions.
Generated by the class exceptions correspond to the following errors:

• SCL-20020: unspecified stream error
• SCL-20021: stream not open
• SCL-20022: read only stream
• SCL-20023: write only stream
• SCL-20024: unknown class
• SCL-20025: unexpected class
• SCL-20026: unsupported class
• SCL-20027: incompleted read operation
• SCL-20028: incompleted write operation
• SCL-20029: stream opening error
• SCL-20030: data read error
• SCL-20031: data write error
• SCL-20032: NSNumber error
• SCL-20033: incorrect stream mode
• SCL-20034: empty file stream path
• SCL-20035: end of stream
• SCL-20036: incorrect offset
• SCL-20037: incorrect offset whence

Method Documentation

+ (instancetype) exception

Returns a generic stream exception SCL-20020 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithEmptyPath

Returns an empty file stream path exception SCL-20034 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithEndOfFile

Returns an end of stream exception SCL-20035 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithEndOfFile:

(NSString *)

file

Returns an end of stream exception SCL-20035 created by using the specified file stream name.

Parameters

file	- the name of the file stream

Returns

A created exception

+ (instancetype) exceptionWithNotOpen

Returns a not open stream exception SCL-20021 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithNotOpenStream:

(NSString *)

stream

Returns a not open stream exception SCL-20021 created by using the specified erroneous stream name.

Parameters

stream

- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithOpenError:

(SCInteger)

error

Returns a stream opening exception SCL-20029 created by using the specified error code.

Parameters

error

- the detected error code

Returns

A created exception

+ (instancetype) exceptionWithOpenError:		(SCInteger)	error
stream:		(NSString *)	stream

Returns a stream opening exception SCL-20029 created by using the specified error code and erroneous stream name.

Parameters

error	- the detected error code
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithOpenMode:

(SCFileStreamOpenMode)

mode

Returns an incorrect open mode exception SCL-20033 created by using the specified incorrect mode.

Parameters

mode	- the incorrect open mode

Returns

A created exception

+ (instancetype) exceptionWithOpenMode:		(SCFileStreamOpenMode)	mode
path:		(NSString *)	path

Returns an incorrect open mode exception SCL-20033 created by using the specified incorrect mode and file stream path.

Parameters

mode	- the incorrect open mode
path	- the path to the file stream

Returns

A created exception

+ (instancetype) exceptionWithReaded:		(SCSize)	readed
waited:		(SCSize)	waited

Returns an incompleted reading operation SCL-20027 created by using the specified number of actually readed bytes and number of waited bytes.

Parameters

readed	- the number of the actually readed bytes
waited	- the number of the required bytes during the reading operation

Returns

A created exception

+ (instancetype) exceptionWithReaded:		(SCSize)	readed
waited:		(SCSize)	waited
stream:		(NSString *)	stream

Returns an incompleted reading operation SCL-20027 created by using the specified number of actually readed bytes, number of waited bytes and erroneous stream name.

Parameters

readed	- the number of the actually readed bytes
waited	- the number of the required bytes during the reading operation
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithReadError:

(SCInteger)

error

Returns a reading exception SCL-20030 created by using the specified error code.

Parameters

error

- the reading error code

Returns

A created exception

+ (instancetype) exceptionWithReadError:		(SCInteger)	error
stream:		(NSString *)	stream

Returns a reading exception SCL-20030 created by using the specified error code and stream name.

Parameters

error	- the reading error code
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithReadOnly

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

Returns

A created exception

+ (instancetype) exceptionWithReadOnlyStream:

(NSString *)

stream

Returns a read only stream exception SCL-20022 created by using the specified erroneous stream name.

Parameters

stream

- the name of the erroneous stream

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 code of the detected error
eid	- the error ID

Returns

A created exception

+ (instancetype) exceptionWithSeekError:

(SCSystemError)

error

Returns a seeking exception SCL-20036 created by using the specified seeking error code.

Parameters

error

- the seeking error code

Returns

A created exception

+ (instancetype) exceptionWithSeekError:		(SCSystemError)	error
path:		(NSString *)	path

Returns a seeking exception SCL-20036 created by using the specified seeking error code and file stream path.

Parameters

error	- the seeking error code
path	- the path to the file stream

Returns

A created exception

+ (instancetype) exceptionWithSeekError:		(SCSystemError)	error
whence:		(SCFileStreamOffsetWhence)	whence
offset:		(NSInteger)	offset

Returns a seeking exception SCL-20036 created by using the specified seeking error code, seeking offset whence and seeking offset.

Parameters

error	- the seeking error code
whence	- the seeking offset whence
offset	- the seeking offset

Returns

A created exception

+ (instancetype) exceptionWithSeekError:		(SCSystemError)	error
whence:		(SCFileStreamOffsetWhence)	whence
offset:		(NSInteger)	offset
path:		(NSString *)	path

Returns a seeking exception SCL-20036 created by using the specified seeking error code, seeking offset whence, seeking offset and path to the file stream.

Parameters

error	- the seeking error code
whence	- the seeking offset whence
offset	- the seeking offset
path	- the file stream path

Returns

A created exception

+ (instancetype) exceptionWithStream:

(NSString *)

stream

Returns a generic stream exception SCL-20020 created by using the specified stream name.

Parameters

stream

- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithStream:		(NSString *)	stream
reason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

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

Parameters

stream	- the name of the erroneous stream
reason	- the error description
code	- the code of the detected error
eid	- the error ID

Returns

A created exception

+ (instancetype) exceptionWithUnexpected:		(NSString *)	unexpected
expected:		(NSString *)	expected

Returns an unexpected class exception SCL-20025 created by using the specified unexpected class name and expected class name.

Parameters

unexpected	- the unexpected class name
expected	- the expected class name

Returns

A created exception

+ (instancetype) exceptionWithUnexpected:		(NSString *)	unexpected
expected:		(NSString *)	expected
stream:		(NSString *)	stream

Returns an unexpected class exception SCL-20025 created by using the specified unexpected class name, expected class name and erroneous stream name.

Parameters

unexpected	- the unexpected class name
expected	- the expected class name
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithUnknown:

(NSString *)

name

Returns an unknown class exception SCL-20024 created by using the specified unknown class name.

Parameters

name	- the unknown class name

Returns

A created exception

+ (instancetype) exceptionWithUnknown:		(NSString *)	name
stream:		(NSString *)	stream

Returns an unknown class exception SCL-20024 created by using the specified unknown class name and erroneous stream name.

Parameters

name	- the unknown class name
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithUnsupported:

(NSString *)

name

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

Parameters

name	- the unsupported class name

Returns

A created exception

+ (instancetype) exceptionWithUnsupported:		(NSString *)	name
stream:		(NSString *)	stream

Returns an unsupported class exception SCL-20026 created by using the specified unsupported class name and erroneous stream name.

Parameters

name	- the unsupported class name
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithUnsupportedNumberType:

(NSString *)

type

Returns a number object exception SCL-20032 created by using the specified unsupported number object type.

Parameters

type	- the type of the unsupported object number

Returns

A created exception

+ (instancetype) exceptionWithUnsupportedNumberType:		(NSString *)	type
stream:		(NSString *)	stream

Returns a number object exception SCL-20032 created by using the specified type of the unsupported number object and erroneous stream name.

Parameters

type	- the unsupported number object type
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithWhence:

(SCFileStreamOffsetWhence)

whence

Returns an incorrect offset whence exception SCL-20037 created by using the specified incorrect offset whence.

Parameters

whence

- the incorrect offset whence

Returns

A created exception

+ (instancetype) exceptionWithWhence:		(SCFileStreamOffsetWhence)	whence
path:		(NSString *)	path

Returns an incorrect offset whence exception SCL-20037 created by using the specified incorrect offset whence and file stream path.

Parameters

whence	- the incorrect offset whence
path	- the path to the file stream

Returns

A created exception

+ (instancetype) exceptionWithWrited:		(SCSize)	writed
waited:		(SCSize)	waited

Returns an incompleted writing operation SCL-20028 created by using the specified number of actually writed bytes and number of waited bytes.

Parameters

writed	- the number of the actually writed bytes
waited	- the number of the waited bytes

Returns

A created exception

+ (instancetype) exceptionWithWrited:		(SCSize)	writed
waited:		(SCSize)	waited
stream:		(NSString *)	stream

Returns an incompleted writing operation SCL-20028 created by using the specified number of actually writed bytes, number of waited bytes and erroneous stream name.

Parameters

writed	- the number of the actually writed bytes
waited	- the number of the waited bytes
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithWriteError:

(SCInteger)

error

Returns a writing exception SCL-20031 created by using the specified writing error code.

Parameters

error

- the writing error code

Returns

A created exception

+ (instancetype) exceptionWithWriteError:		(SCInteger)	error
stream:		(NSString *)	stream

Returns a writing exception SCL-20031 created by using the specified writing error code and erroneous stream name.

Parameters

error	- the writing error code
stream	- the name of the erroneous stream

Returns

A created exception

+ (instancetype) exceptionWithWriteOnly

Returns a write only stream exception SCL-20023 created by using the default settings.

Returns

A created exception

+ (instancetype) exceptionWithWriteOnlyStream:

(NSString *)

stream

Returns a write only stream exception SCL-20023 created by using the specified erroneous stream name.

Parameters

stream

- the name of the erroneous stream

Returns

A created exception

- (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 code of the detected error
eid	- the error ID

Returns

A newly initialized exception

- (instancetype) initWithStream:		(NSString *)	stream
reason:		(NSString *)	reason
code:		(SCInteger)	code
eid:		(NSString *)	eid

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

Attention

Designed initializer

Parameters

stream	- the name of the erroneous stream
reason	- the error description
code	- the code of the detected error
eid	- the error ID

Returns

A newly initialized exception

Property Documentation

- (NSString*) expected

readnonatomicretain

Name of the expected class

- (NSString*) numberType

readnonatomicretain

Unsupported number object type

- (NSInteger) offset

readnonatomicassign

Incorrect file stream offset

- (SCInteger) openError

readnonatomicassign

Code of the stream opening error

- (SCFileStreamOpenMode) openMode

readnonatomicassign

Incorrect stream open mode

- (SCSize) readedBytes

readnonatomicassign

Number of actually readed bytes from the stream

- (SCInteger) readError

readnonatomicassign

Code of the stream reading error

- (SCSystemError) seekError

readnonatomicassign

Stream seeking error code

- (NSString*) streamName

readnonatomicretain

Erroneous stream name

- (NSString*) unexpected

readnonatomicretain

Name of the unexpected class

- (NSString*) unknown

readnonatomicretain

Name of the detected unknown class

- (NSString*) unsupported

readnonatomicretain

Name of the detected unsupported by streams class

- (SCSize) waitedBytes

readnonatomicassign

Number of waited during reading or writing operation bytes

- (SCFileStreamOffsetWhence) whence

readnonatomicassign

Incorrect file stream offset whence

- (SCSize) writedBytes

readnonatomicassign

Number of actually writed bytes to the stream

- (SCInteger) writeError

readnonatomicassign

Code of the stream writing error

---

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

• SCStreamException.h
• SCStreamException.m