Samond Classes Library 1.2.1-RELEASE build 181
List of all members
SCFileStreamException Class Reference

Exception class SCFileStreamException. More...

#import <SCFileStreamException.h>

Inheritance diagram for SCFileStreamException:
SCStreamException SCException

Instance Properties

SCFileStreamOpenMode openMode
 
SCSystemError seekError
 
NSInteger offset
 
SCFileStreamOffsetWhence whence
 

Creating and Initializing Incorrect Open Mode Exception (SCL-20033)

(instancetype) - initWithOpenMode:path:
 
(instancetype) - initWithOpenMode:
 
(instancetype) + exceptionWithOpenMode:path:
 
(instancetype) + exceptionWithOpenMode:
 

Creating and Initializing Empty Path Exception (SCL-20034)

(instancetype) - initWithEmptyPath
 
(instancetype) + exceptionWithEmptyPath
 

Creating and Initializing End of Stream Exception (SCL-20035)

(instancetype) - initWithEndOfFile:
 
(instancetype) - initWithEndOfFile
 
(instancetype) + exceptionWithEndOfFile:
 
(instancetype) + exceptionWithEndOfFile
 

Creating and Initializing Offset Exception (SCL-20036 and SCL-20037)

(instancetype) - initWithSeekError:whence:offset:path:
 
(instancetype) - initWithSeekError:whence:offset:
 
(instancetype) - initWithSeekError:path:
 
(instancetype) - initWithSeekError:
 
(instancetype) - initWithWhence:path:
 
(instancetype) - initWithWhence:
 
(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 SCStreamException
(instancetype) - initWithStream:reason:code:eid:
 
(instancetype) - initWithReason:code:eid:
 
(instancetype) - initWithStreamName:
 
(instancetype) - init
 
(instancetype) - initWithNotOpenStream:
 
(instancetype) - initWithNotOpen
 
(instancetype) - initWithReadOnlyStream:
 
(instancetype) - initWithReadOnly
 
(instancetype) - initWithWriteOnlyStream:
 
(instancetype) - initWithWriteOnly
 
(instancetype) - initWithUnknown:stream:
 
(instancetype) - initWithUnknown:
 
(instancetype) - initWithUnexpected:expected:stream:
 
(instancetype) - initWithUnexpected:expected:
 
(instancetype) - initWithUnsupported:stream:
 
(instancetype) - initWithUnsupported:
 
(instancetype) - initWithReaded:waited:stream:
 
(instancetype) - initWithReaded:waited:
 
(instancetype) - initWithWrited:waited:stream:
 
(instancetype) - initWithWrited:waited:
 
(instancetype) - initWithOpenError:stream:
 
(instancetype) - initWithOpenError:
 
(instancetype) - initWithReadError:stream:
 
(instancetype) - initWithReadError:
 
(instancetype) - initWithWriteError:stream:
 
(instancetype) - initWithWriteError:
 
(instancetype) - initWithUnsupportedNumberType:stream:
 
(instancetype) - initWithUnsupportedNumberType:
 
- Instance Methods inherited from SCException
(instancetype) - initWithName:reason:code:eid:
 
- Class Methods inherited from SCStreamException
(instancetype) + exceptionWithStream:reason:code:eid:
 
(instancetype) + exceptionWithReason:code:eid:
 
(instancetype) + exceptionWithStream:
 
(instancetype) + exception
 
(instancetype) + exceptionWithNotOpenStream:
 
(instancetype) + exceptionWithNotOpen
 
(instancetype) + exceptionWithReadOnlyStream:
 
(instancetype) + exceptionWithReadOnly
 
(instancetype) + exceptionWithWriteOnlyStream:
 
(instancetype) + exceptionWithWriteOnly
 
(instancetype) + exceptionWithUnknown:stream:
 
(instancetype) + exceptionWithUnknown:
 
(instancetype) + exceptionWithUnexpected:expected:stream:
 
(instancetype) + exceptionWithUnexpected:expected:
 
(instancetype) + exceptionWithUnsupported:stream:
 
(instancetype) + exceptionWithUnsupported:
 
(instancetype) + exceptionWithReaded:waited:stream:
 
(instancetype) + exceptionWithReaded:waited:
 
(instancetype) + exceptionWithWrited:waited:stream:
 
(instancetype) + exceptionWithWrited:waited:
 
(instancetype) + exceptionWithOpenError:stream:
 
(instancetype) + exceptionWithOpenError:
 
(instancetype) + exceptionWithReadError:stream:
 
(instancetype) + exceptionWithReadError:
 
(instancetype) + exceptionWithWriteError:stream:
 
(instancetype) + exceptionWithWriteError:
 
(instancetype) + exceptionWithUnsupportedNumberType:stream:
 
(instancetype) + exceptionWithUnsupportedNumberType:
 
- Properties inherited from SCStreamException
NSString * streamName
 
NSString * unknown
 
NSString * unexpected
 
NSString * expected
 
NSString * unsupported
 
SCSize readedBytes
 
SCSize writedBytes
 
SCSize waitedBytes
 
SCInteger openError
 
SCInteger readError
 
SCInteger writeError
 
NSString * numberType
 
- Properties inherited from SCException
SCInteger code
 
NSString * eid
 

Detailed Description

Exception class SCFileStreamException.

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

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

Method Documentation

+ (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) 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) 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) 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) initWithEmptyPath

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

Returns
A newly initialized exception
- (instancetype) initWithEndOfFile

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

Returns
A newly initialized exception
- (instancetype) initWithEndOfFile: (NSString *)  file

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

Parameters
file- the name of the file stream
Returns
A newly initialized exception
- (instancetype) initWithOpenMode: (SCFileStreamOpenMode)  mode

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

Parameters
mode- the incorrect open mode
Returns
A newly initialized exception
- (instancetype) initWithOpenMode: (SCFileStreamOpenMode)  mode
path: (NSString *)  path 

Initializes an incorrect open mode exception SCL-20033 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 newly initialized exception
- (instancetype) initWithSeekError: (SCSystemError)  error

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

Parameters
error- the seeking error code
Returns
A newly initialized exception
- (instancetype) initWithSeekError: (SCSystemError)  error
path: (NSString *)  path 

Initializes a seeking exception SCL-20036 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 newly initialized exception
- (instancetype) initWithSeekError: (SCSystemError)  error
whence: (SCFileStreamOffsetWhence)  whence
offset: (NSInteger)  offset 

Initializes a seeking exception SCL-20036 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 newly initialized exception
- (instancetype) initWithSeekError: (SCSystemError)  error
whence: (SCFileStreamOffsetWhence)  whence
offset: (NSInteger)  offset
path: (NSString *)  path 

Initializes a seeking exception SCL-20036 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 newly initialized exception
- (instancetype) initWithWhence: (SCFileStreamOffsetWhence)  whence

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

Parameters
whence- the incorrect offset whence
Returns
A newly initialized exception
- (instancetype) initWithWhence: (SCFileStreamOffsetWhence)  whence
path: (NSString *)  path 

Initializes an incorrect offset whence exception SCL-20037 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 newly initialized exception

Property Documentation

- (NSInteger) offset
readatomicassign

Incorrect file stream offset

- (SCFileStreamOpenMode) openMode
readatomicassign

Incorrect file stream open mode

- (SCSystemError) seekError
readatomicassign

Stream seeking error code

- (SCFileStreamOffsetWhence) whence
readatomicassign

Incorrect file stream offset whence

The documentation for this class was generated from the following files:
Generated on Mon Apr 10 2017 15:23:17 for Samond Classes Library 1.2.1-RELEASE build 181 by   doxygen 1.8.9.1