Samond Classes Library 1.1.6-RELEASE build 132

SCFileStreamException.h

Go to the documentation of this file.
00001 //
00002 //  SCFileStreamException.h
00003 //  scl
00004 //
00005 //  Created by Viacheslav Smolensky on 30.03.12.
00006 //  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
00007 //
00008 
00015 #import <scl/SCStreamException.h>
00016 #import <scl/SCFileStream.h>
00017 
00018 #define SCFileStreamExceptionClass @"SCFileStreamException" ///< SCFileStreamException class name
00019 
00020 #pragma mark Exception supporting types
00021 
00027 enum _SCFileStreamError {
00028     SCFileStreamErrorOpenMode       = 100,  
00029     SCFileStreamErrorEmptyPath      = 101,  
00030     SCFileStreamErrorEOF            = 102,  
00031         SCFileStreamErrorOffset         = 103,  
00032     SCFileStreamErrorOffsetWhence   = 104,  
00033 };
00034 
00040 typedef SCStreamError SCFileStreamError;
00041 
00042 #pragma mark -
00043 
00057 @interface SCFileStreamException : SCStreamException {
00058     SCFileStreamOpenMode fOpenMode;     // Incorrect file stream open mode
00059     SCSystemError fSeekError;           // Seeking system error code
00060     SCLong fOffset;                     // Incorrect offset
00061     SCFileStreamOffsetWhence fWhence;   // Incorrect whence
00062 }
00063 #pragma mark -
00064 #pragma mark Class properties
00065 #if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
00066 // Incorrect open mode property
00067 @property (assign, readonly, getter=openMode) SCFileStreamOpenMode openMode;
00068 // Seeking error code property
00069 @property (assign, readonly, getter=seekError) SCSystemError seekError;
00070 // Incorrect offset property
00071 @property (assign, readonly, getter=offset) SCLong offset;
00072 // Incorrect whence property
00073 @property (assign, readonly, getter=whence) SCFileStreamOffsetWhence whence;
00074 #endif
00075 
00076 #pragma mark -
00077 #pragma mark Creating and Initializing Incorrect Open Mode Exception
00078 
00087 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00088                                       openMode:(SCFileStreamOpenMode)mode
00089                                         reason:(NSString *)reason;
00090 
00097 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00098                                       openMode:(SCFileStreamOpenMode)mode;
00099 
00106 + (SCFileStreamException *)exceptionWithOpenMode:(SCFileStreamOpenMode)mode
00107                                           reason:(NSString *)reason;
00108 
00114 + (SCFileStreamException *)exceptionWithOpenMode:(SCFileStreamOpenMode)mode;
00115 
00124 - (id)initWithStream:(NSString *)stream
00125             openMode:(SCFileStreamOpenMode)mode
00126               reason:(NSString *)reason;
00127 
00134 - (id)initWithStream:(NSString *)stream openMode:(SCFileStreamOpenMode)mode;
00135 
00142 - (id)initWithOpenMode:(SCFileStreamOpenMode)mode reason:(NSString *)reason;
00143 
00149 - (id)initWithOpenMode:(SCFileStreamOpenMode)mode;
00150 
00151 #pragma mark -
00152 #pragma mark Creating and Initializing Empty Path Exception
00153 
00159 + (SCFileStreamException *)exceptionWithEmptyPathReason:(NSString *)reason;
00160 
00165 + (SCFileStreamException *)exceptionWithEmptyPath;
00166 
00172 - (id)initWithEmptyPathReason:(NSString *)reason;
00173 
00178 - (id)initWithEmptyPath;
00179 
00180 #pragma mark -
00181 #pragma mark Creating and Initializing End of Stream Exception
00182 
00190 + (SCFileStreamException *)exceptionWithEndOfStream:(NSString *)stream reason:(NSString *)reason;
00191 
00197 + (SCFileStreamException *)exceptionWithEndOfStream:(NSString *)stream;
00198 
00204 + (SCFileStreamException *)exceptionWithEndOfFileReason:(NSString *)reason;
00205 
00210 + (SCFileStreamException *)exceptionWithEndOfFile;
00211 
00218 - (id)initWithEndOfStream:(NSString *)stream reason:(NSString *)reason;
00219 
00225 - (id)initWithEndOfStream:(NSString *)stream;
00226 
00232 - (id)initWithEndOfFileReason:(NSString *)reason;
00233 
00238 - (id)initWithEndOfFile;
00239 
00240 #pragma mark -
00241 #pragma mark Creating and Initializing Offset Exception
00242 
00253 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00254                                                                          seekError:(SCSystemError)error
00255                                         offset:(SCLong)offset
00256                                         whence:(SCFileStreamOffsetWhence)whence
00257                                         reason:(NSString *)reason;
00258 
00268 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00269                                                                          seekError:(SCSystemError)error
00270                                         offset:(SCLong)offset
00271                                         whence:(SCFileStreamOffsetWhence)whence;
00272 
00282 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00283                                                                          seekError:(SCSystemError)error
00284                                         offset:(SCLong)offset
00285                                         reason:(NSString *)reason;
00286 
00295 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00296                                                                          seekError:(SCSystemError)error
00297                                         offset:(SCLong)offset;
00298 
00307 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream
00308                                                                          seekError:(SCSystemError)error
00309                                         reason:(NSString *)reason;
00310 
00317 + (SCFileStreamException *)exceptionWithStream:(NSString *)stream seekError:(SCSystemError)error;
00318 
00325 + (SCFileStreamException *)exceptionWithSeekErrorStream:(NSString *)stream
00326                                                  reason:(NSString *)reason;
00327 
00333 + (SCFileStreamException *)exceptionWithSeekErrorStream:(NSString *)stream;
00334 
00344 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error
00345                                                                                    offset:(SCLong)offset
00346                                                                                    whence:(SCFileStreamOffsetWhence)whence
00347                                                                                    reason:(NSString *)reason;
00348 
00356 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error
00357                                                                                    offset:(SCLong)offset
00358                                                                                    whence:(SCFileStreamOffsetWhence)whence;
00359 
00368 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error
00369                                                                                    offset:(SCLong)offset
00370                                                                                    reason:(NSString *)reason;
00371 
00378 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error offset:(SCLong)offset;
00379 
00386 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error reason:(NSString *)reason;
00387 
00393 + (SCFileStreamException *)exceptionWithSeekError:(SCSystemError)error;
00394 
00400 + (SCFileStreamException *)exceptionWithSeekErrorReason:(NSString *)reason;
00401 
00406 + (SCFileStreamException *)exceptionWithSeekError;
00407 
00418 - (id)initWithStream:(NSString *)stream
00419                    seekError:(SCSystemError)error
00420               offset:(SCLong)offset
00421               whence:(SCFileStreamOffsetWhence)whence
00422               reason:(NSString *)reason;
00423 
00433 - (id)initWithStream:(NSString *)stream
00434                    seekError:(SCSystemError)error
00435               offset:(SCLong)offset
00436               whence:(SCFileStreamOffsetWhence)whence;
00437 
00447 - (id)initWithStream:(NSString *)stream
00448                    seekError:(SCSystemError)error
00449               offset:(SCLong)offset
00450               reason:(NSString *)reason;
00451 
00459 - (id)initWithStream:(NSString *)stream seekError:(SCSystemError)error offset:(SCLong)offset;
00460 
00469 - (id)initWithStream:(NSString *)stream seekError:(SCSystemError)error reason:(NSString *)reason;
00470 
00477 - (id)initWithStream:(NSString *)stream seekError:(SCSystemError)error;
00478 
00485 - (id)initWithSeekErrorStream:(NSString *)stream reason:(NSString *)reason;
00486 
00492 - (id)initWithSeekErrorStream:(NSString *)stream;
00493 
00503 - (id)initWithSeekError:(SCSystemError)error
00504                                  offset:(SCLong)offset
00505                                  whence:(SCFileStreamOffsetWhence)whence
00506                                  reason:(NSString *)reason;
00507 
00515 - (id)initWithSeekError:(SCSystemError)error
00516                                  offset:(SCLong)offset
00517                                  whence:(SCFileStreamOffsetWhence)whence;
00518 
00527 - (id)initWithSeekError:(SCSystemError)error offset:(SCLong)offset reason:(NSString *)reason;
00528 
00535 - (id)initWithSeekError:(SCSystemError)error offset:(SCLong)offset;
00536 
00543 - (id)initWithSeekError:(SCSystemError)error reason:(NSString *)reason;
00544 
00550 - (id)initWithSeekError:(SCSystemError)error;
00551 
00557 - (id)initWithSeekErrorReason:(NSString *)reason;
00558 
00563 - (id)initWithSeekError;
00564 
00565 #pragma mark -
00566 #pragma mark Creating and Initializing Offset Whence Exception
00567 
00576 + (id)exceptionWithStream:(NSString *)stream
00577                    whence:(SCFileStreamOffsetWhence)whence
00578                    reason:(NSString *)reason;
00579 
00586 + (id)exceptionWithStream:(NSString *)stream whence:(SCFileStreamOffsetWhence)whence;
00587 
00595 + (id)exceptionWithWhence:(SCFileStreamOffsetWhence)whence reason:(NSString *)reason;
00596 
00602 + (id)exceptionWithWhence:(SCFileStreamOffsetWhence)whence;
00603 
00612 - (id)initWithStream:(NSString *)stream
00613               whence:(SCFileStreamOffsetWhence)whence
00614               reason:(NSString *)reason;
00615 
00622 - (id)initWithStream:(NSString *)stream whence:(SCFileStreamOffsetWhence)whence;
00623 
00630 - (id)initWithWhence:(SCFileStreamOffsetWhence)whence reason:(NSString *)reason;
00631 
00637 - (id)initWithWhence:(SCFileStreamOffsetWhence)whence;
00638 
00639 #pragma mark -
00640 #pragma mark Querying Exception Properties
00641 
00646 - (SCFileStreamOpenMode)openMode;
00647 
00652 - (SCSystemError)seekError;
00653 
00658 - (SCLong)offset;
00659 
00664 - (SCFileStreamOffsetWhence)whence;
00665 
00666 @end
 All Classes Files Functions Typedefs Enumerations Enumerator Defines