SCFileStreamException Class Reference

File streams exception class. More...

#import <SCFileStreamException.h>

Inheritance diagram for SCFileStreamException:

List of all members.

Public Member Functions
Querying Exception Properties
(SCFileStreamOpenMode)	- openMode
(SCSystemError)	- seekError
(SCLong)	- offset
(SCFileStreamOffsetWhence)	- whence
Creating and Initializing Incorrect Open Mode Exception
(SCFileStreamException *)	+ exceptionWithStream:openMode:reason:
(SCFileStreamException *)	+ exceptionWithStream:openMode:
(SCFileStreamException *)	+ exceptionWithOpenMode:reason:
(SCFileStreamException *)	+ exceptionWithOpenMode:
(id)	- initWithStream:openMode:reason:
(id)	- initWithStream:openMode:
(id)	- initWithOpenMode:reason:
(id)	- initWithOpenMode:
Creating and Initializing Empty Path Exception
(SCFileStreamException *)	+ exceptionWithEmptyPathReason:
(SCFileStreamException *)	+ exceptionWithEmptyPath
(id)	- initWithEmptyPathReason:
(id)	- initWithEmptyPath
Creating and Initializing End of Stream Exception
(SCFileStreamException *)	+ exceptionWithEndOfStream:reason:
(SCFileStreamException *)	+ exceptionWithEndOfStream:
(SCFileStreamException *)	+ exceptionWithEndOfFileReason:
(SCFileStreamException *)	+ exceptionWithEndOfFile
(id)	- initWithEndOfStream:reason:
(id)	- initWithEndOfStream:
(id)	- initWithEndOfFileReason:
(id)	- initWithEndOfFile
Creating and Initializing Offset Exception
(SCFileStreamException *)	+ exceptionWithStream:seekError:offset:whence:reason:
(SCFileStreamException *)	+ exceptionWithStream:seekError:offset:whence:
(SCFileStreamException *)	+ exceptionWithStream:seekError:offset:reason:
(SCFileStreamException *)	+ exceptionWithStream:seekError:offset:
(SCFileStreamException *)	+ exceptionWithStream:seekError:reason:
(SCFileStreamException *)	+ exceptionWithStream:seekError:
(SCFileStreamException *)	+ exceptionWithSeekErrorStream:reason:
(SCFileStreamException *)	+ exceptionWithSeekErrorStream:
(SCFileStreamException *)	+ exceptionWithSeekError:offset:whence:reason:
(SCFileStreamException *)	+ exceptionWithSeekError:offset:whence:
(SCFileStreamException *)	+ exceptionWithSeekError:offset:reason:
(SCFileStreamException *)	+ exceptionWithSeekError:offset:
(SCFileStreamException *)	+ exceptionWithSeekError:reason:
(SCFileStreamException *)	+ exceptionWithSeekError:
(SCFileStreamException *)	+ exceptionWithSeekErrorReason:
(SCFileStreamException *)	+ exceptionWithSeekError
(id)	- initWithStream:seekError:offset:whence:reason:
(id)	- initWithStream:seekError:offset:whence:
(id)	- initWithStream:seekError:offset:reason:
(id)	- initWithStream:seekError:offset:
(id)	- initWithStream:seekError:reason:
(id)	- initWithStream:seekError:
(id)	- initWithSeekErrorStream:reason:
(id)	- initWithSeekErrorStream:
(id)	- initWithSeekError:offset:whence:reason:
(id)	- initWithSeekError:offset:whence:
(id)	- initWithSeekError:offset:reason:
(id)	- initWithSeekError:offset:
(id)	- initWithSeekError:reason:
(id)	- initWithSeekError:
(id)	- initWithSeekErrorReason:
(id)	- initWithSeekError
Creating and Initializing Offset Whence Exception
(id)	+ exceptionWithStream:whence:reason:
(id)	+ exceptionWithStream:whence:
(id)	+ exceptionWithWhence:reason:
(id)	+ exceptionWithWhence:
(id)	- initWithStream:whence:reason:
(id)	- initWithStream:whence:
(id)	- initWithWhence:reason:
(id)	- initWithWhence:

---

Detailed Description

File streams exception class.

Generates when file stream error detected.
Class was introduced in version 1.1.3.

Class declares the following properties:

• SCFileStreamOpenMode incorrectOpenMode - file stream incorrect open mode (read only)
• SCSystemError seekError - system error code during seeking (read only)
• SCLong offset - incorrect file stream offset (read only)
• SCFileStreamOffsetWhence whence - incorrect file stream whence (read only)

---

Member Function Documentation

+ (SCFileStreamException *) exceptionWithEmptyPath

Returns a created file stream empty path exception.

Returns:

Created exception

+ (SCFileStreamException *) exceptionWithEmptyPathReason:

(NSString *)

reason

Returns a file stream empty path exception created by using the specified error description.

Parameters:

reason

- error description

Returns:

Created exception

+ (SCFileStreamException *) exceptionWithEndOfFile

Returns an end of stream exception created by using the default error description.

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithEndOfFileReason:

(NSString *)

reason

Returns an end of stream exception created by using the specified error description.

Parameters:

reason

- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithEndOfStream:

(NSString *)

stream

Returns an end of stream exception created by using the specified stream name.

Parameters:

stream

- stream name

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithEndOfStream:		(NSString *)	stream
reason:		(NSString *)	reason

Returns an end of stream exception created by using the specified stream name and error description.

Parameters:

stream	- stream name
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithOpenMode:

(SCFileStreamOpenMode)

mode

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

Parameters:

mode	- incorrect open mode

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithOpenMode:		(SCFileStreamOpenMode)	mode
reason:		(NSString *)	reason

Returns an exception created by using the specified incorrect open mode and error description.

Parameters:

mode	- incorrect open mode
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError

Returns an offset exception created by using the default error description.

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:

(SCSystemError)

error

Returns an offset exception created by using the specified system error code.

Parameters:

error

- system error code

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset

Returns an offset exception created by using the specified system error code and offset.

Parameters:

error	- system error code
offset	- stream offset

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
reason:		(NSString *)	reason

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

Parameters:

error	- system error code
offset	- stream offset
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Returns an offset exception created by using the specified system error code, offset and whence.

Parameters:

error	- system error code
offset	- stream offset
whence	- offset whence

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Returns an offset exception created by using the specified system error code, offset, whence and error description.

Parameters:

error	- system error code
offset	- stream offset
whence	- offset whence
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekError:		(SCSystemError)	error
reason:		(NSString *)	reason

Returns an offset exception created by using the specified system error code and error description.

Parameters:

error	- system error code
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekErrorReason:

(NSString *)

reason

Returns an offset exception created by using the specified error description.

Parameters:

reason

- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekErrorStream:

(NSString *)

stream

Returns an offset exception created by using the specified stream name.

Parameters:

stream

- stream name

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithSeekErrorStream:		(NSString *)	stream
reason:		(NSString *)	reason

Returns an offset exception created by using the specified stream name and error description.

Parameters:

stream	- stream name
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
openMode:		(SCFileStreamOpenMode)	mode

Returns an exception created by using the specified stream name and incorrect open mode.

Parameters:

stream	- stream name
mode	- incorrect open mode

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
openMode:		(SCFileStreamOpenMode)	mode
reason:		(NSString *)	reason

Returns an exception created by using the specified stream name, incorrect open mode and error description.

Parameters:

stream	- stream name
mode	- incorrect open mode
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error

Returns an offset exception created by using the specified stream name and system error code.

Parameters:

stream	- stream name
error	- system error code

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset

Returns an offset exception created by using the specified stream name, system error code and offset.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
reason:		(NSString *)	reason

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

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Returns an offset exception created by using the specified stream name, system error code, offset and whence.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
whence	- offset whence

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Returns an offset exception created by using the specified stream name, system error code, offset, whence and error description.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
whence	- offset whence
reason	- error description

Returns:

A created exception

+ (SCFileStreamException *) exceptionWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
reason:		(NSString *)	reason

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

Parameters:

stream	- stream name
error	- system error code
reason	- error description

Returns:

A created exception

+ (id) exceptionWithStream:		(NSString *)	stream
whence:		(SCFileStreamOffsetWhence)	whence

Returns an offset whence exception created by using the specified stream name and incorrect whence.

Parameters:

stream	- stream name
whence	- offset whence

Returns:

A created exception

+ (id) exceptionWithStream:		(NSString *)	stream
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Returns an offset whence exception created by using the specified stream name, incorrect whence and error description.

Parameters:

stream	- stream name
whence	- offset whence
reason	- error description

Returns:

A created exception

+ (id) exceptionWithWhence:

(SCFileStreamOffsetWhence)

whence

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

Parameters:

whence

- offset whence

Returns:

A created exception

+ (id) exceptionWithWhence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Returns an offset whence exception created by using the specified incorrect whence and error description.

Parameters:

whence	- offset whence
reason	- error description

Returns:

A created exception

- (id) initWithEmptyPath

Initializes the file stream empty path exception.

Returns:

A newly initialized exception

- (id) initWithEmptyPathReason:

(NSString *)

reason

Initializes the file stream empty path exception with the specified error description.

Parameters:

reason

- error description

Returns:

A newly initialized exception

- (id) initWithEndOfFile

Initializes the end of stream exception using the default error description.

Returns:

A newly initialized exception

- (id) initWithEndOfFileReason:

(NSString *)

reason

Initializes the end of stream exception using the specified error description.

Parameters:

reason

- error description

Returns:

A newly initialized exception

- (id) initWithEndOfStream:

(NSString *)

stream

Initializes the end of stream exception using the specified stream name.

Parameters:

stream

- stream name

Returns:

A newly initialized exception

- (id) initWithEndOfStream:		(NSString *)	stream
reason:		(NSString *)	reason

Initializes the end of stream exception using the specified stream name and error description.

Parameters:

stream	- stream name
reason	- error description

Returns:

A newly initialized exception

- (id) initWithOpenMode:

(SCFileStreamOpenMode)

mode

Initializes the exception using the specified incorrect open mode.

Parameters:

mode	- incorrect open mode

Returns:

A newly initialized exception

- (id) initWithOpenMode:		(SCFileStreamOpenMode)	mode
reason:		(NSString *)	reason

Initializes the exception using the specified incorrect open mode and error description.

Parameters:

mode	- incorrect open mode
reason	- error description

Returns:

A newly initialized exception

- (id) initWithSeekError

Initializes the offset exception using the default error description.

Returns:

A newly initialized exception

- (id) initWithSeekError:

(SCSystemError)

error

Initializes the offset exception using the specified system error code.

Parameters:

error

- system error code

Returns:

A newly initialized exception

- (id) initWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset

Initializes the offset exception using the specified system error code and offset.

Parameters:

error	- system error code
offset	- stream offset

Returns:

A newly initialized exception

- (id) initWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
reason:		(NSString *)	reason

Initializes the offset exception using the specified system error code, offset and error description.

Parameters:

error	- system error code
offset	- stream offset
reason	- error description

Returns:

A newly initialized exception

- (id) initWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Initializes the offset exception using the specified system error code, offset and whence.

Parameters:

error	- system error code
offset	- stream offset
whence	- offset whence

Returns:

A newly initialized exception

- (id) initWithSeekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Initializes the offset exception using the specified system error code, offset, whence and error description.

Parameters:

error	- system error code
offset	- stream offset
whence	- offset whence
reason	- error description

Returns:

A newly initialized exception

- (id) initWithSeekError:		(SCSystemError)	error
reason:		(NSString *)	reason

Initializes the offset exception using the specified system error code and error description.

Parameters:

error	- system error code
reason	- error description

Returns:

A newly initialized exception

- (id) initWithSeekErrorReason:

(NSString *)

reason

Initializes the offset exception using the specified error description.

Parameters:

reason

- error description

Returns:

A newly initialized exception

- (id) initWithSeekErrorStream:

(NSString *)

stream

Initializes the offset exception using the specified stream name.

Parameters:

stream

- stream name

Returns:

A newly initialized exception

- (id) initWithSeekErrorStream:		(NSString *)	stream
reason:		(NSString *)	reason

Initializes the offset exception using the specified stream name and error description.

Parameters:

stream	- stream name
reason	- error description

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
openMode:		(SCFileStreamOpenMode)	mode

Initializes the exception using the specified stream name and incorrect open mode.

Parameters:

stream	- stream name
mode	- incorrect open mode

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
openMode:		(SCFileStreamOpenMode)	mode
reason:		(NSString *)	reason

Initializes the exception using the specified stream name, incorrect open mode and error description.

Parameters:

stream	- stream name
mode	- incorrect open mode
reason	- error description

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error

Initializes the offset exception using the specified stream name and system error code.

Parameters:

stream	- stream name
error	- system error code

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset

Initializes the offset exception using the specified stream name, system error code and offset.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
reason:		(NSString *)	reason

Initializes the offset exception using the specified stream name, system error code, offset and error description.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
reason	- error description

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence

Initializes the offset exception using the specified stream name, system error code, offset and whence.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
whence	- offset whence

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
offset:		(SCLong)	offset
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Initializes the offset exception using the specified stream name, system error code, offset, whence and error description.

Parameters:

stream	- stream name
error	- system error code
offset	- stream offset
whence	- offset whence
reason	- error description

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
seekError:		(SCSystemError)	error
reason:		(NSString *)	reason

Initializes the offset exception using the specified stream name, system error code and error description.

Parameters:

stream	- stream name
error	- system error code
reason	- error description

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
whence:		(SCFileStreamOffsetWhence)	whence

Initializes the offset whence exception using the specified stream name and incorrect whence.

Parameters:

stream	- stream name
whence	- offset whence

Returns:

A newly initialized exception

- (id) initWithStream:		(NSString *)	stream
whence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Initializes the offset whence exception using the specified stream name, incorrect whence and error description.

Parameters:

stream	- stream name
whence	- offset whence
reason	- error description

Returns:

A newly initialized exception

- (id) initWithWhence:

(SCFileStreamOffsetWhence)

whence

Initializes the offset whence exception using the specified incorrect whence.

Parameters:

whence

- offset whence

Returns:

A newly initialized exception

- (id) initWithWhence:		(SCFileStreamOffsetWhence)	whence
reason:		(NSString *)	reason

Initializes the offset whence exception using the specified incorrect whence and error description.

Parameters:

whence	- offset whence
reason	- error description

Returns:

A newly initialized exception

- (SCLong) offset

Returns a file stream incorrect offset.

Returns:

Incorrect offset

- (SCFileStreamOpenMode) openMode

Returns a file stream incorrect open mode.

Returns:

Incorrect open mode

- (SCSystemError) seekError

Returns a file stream seeking system error code.

Returns:

Error code

- (SCFileStreamOffsetWhence) whence

Returns a file stream incorrect whence.

Returns:

Incorrect whence

---

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

• SCFileStreamException.h
• SCFileStreamException.m