SCTextException.h

Go to the documentation of this file.

//
//  SCTextException.h
//  scl
//
//  Created by Viacheslav Smolensky on 05.02.13.
//  Copyright (c) 2007 - 2018 by Samond Development Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <scl/SCCollectionProtocols.h>
#import <scl/SCException.h>

#pragma mark -
#pragma mark Class Constants

#define SCTextExceptionCalss    @"SCTextException"

#define SCTextErrorName         @"SCText"


#pragma mark -
#pragma mark Error ID Contants

#define SCTextEIDUnspecified    @"SCL-20060"

#define SCTextEIDSource         @"SCL-20061"

#define SCTextEIDInputStream    @"SCL-20062"

#define SCTextEIDReadOnly       @"SCL-20063"

#define SCTextEIDEmptyString    @"SCL-20064"

#define SCTextEIDClosedStream   @"SCL-20065"

#define SCTextEIDUnsupported    @"SCL-20066"

#define SCTextEIDRead           @"SCL-20067"

#define SCTextEIDEmptyPath      @"SCL-20068"

#define SCTextEIDDuplicated     @"SCL-20069"

#define SCTextEIDSorter         @"SCL-20070"

#define SCTextEIDOutputStream   @"SCL-20071"

#define SCTextEIDIndex          @"SCL-20072"

#define SCTextEIDRange          @"SCL-20073"

#define SCTextEIDIndexSet       @"SCL-20074"

#define SCTextEIDIndexesCount   @"SCL-20075"

#define SCTextEIDIntersected    @"SCL-20076"

#define SCTextEIDWrite          @"SCL-20077"


#pragma mark -
#pragma mark Class Support Types

typedef enum {
    SCTextErrorUnspecified              = -20060,

    SCTextErrorSource                   = -20061,

    SCTextErrorInputStream              = -20062,

    SCTextErrorReadOnly                 = -20063,

    SCTextErrorEmptyString              = -20064,

    SCTextErrorClosedStream             = -20065,

    SCTextErrorUnsupported              = -20066,
    
    SCTextErrorRead                     = -20067,

    SCTextErrorEmptyPath                = -20068,

    SCTextErrorDuplicated               = -20069,

    SCTextErrorSorter                   = -20070,

    SCTextErrorOutputStream             = -20071,

    SCTextErrorIndex                    = -20072,

    SCTextErrorRange                    = -20073,

    SCTextErrorIndexSet                 = -20074,
    
    SCTextErrorIndexesCount             = -20075,

    SCTextErrorIntersected              = -20076,

    SCTextErrorWrite                    = -20077,

} SCTextError;


@interface SCTextException : SCException {
    NSString    *_textName;     // Erroneous text name
    NSString    *_string;       // Incorrect string
    SCIndex      _index;        // Incorrect index
    NSIndexSet  *_indexSet;     // Incorrect index set
    NSString    *_unsupported;  // Name of unsupported class
    SCULong      _indexesCount; // Number of indexes
    SCULong      _stringsCount; // Number of strings
    NSRange      _range;        // Incorrect range of strings
    NSRange      _intersected;  // Intersected range
    SCStream    *_stream;       // Erroneous stream
}
@property (nonatomic, readonly, retain) NSString *textName;

@property (nonatomic, readonly, retain) NSString *string;

@property (nonatomic, readonly, assign) SCIndex index;

@property (nonatomic, readonly, retain) NSIndexSet *indexSet;

@property (nonatomic, readonly, retain) NSString *unsupported;

@property (nonatomic, readonly, assign) SCULong indexesCount;

@property (nonatomic, readonly, assign) SCULong stringsCount;

@property (nonatomic, readonly, assign) NSRange range;

@property (nonatomic, readonly, assign) NSRange intersected;

@property (nonatomic, readonly, retain) SCStream *stream;

#pragma mark -
#pragma mark Creating and Initializing the Generic Text Exceptions (SCL-20060)
+ (instancetype)exceptionWithName:(NSString *)name reason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (instancetype)exceptionWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (instancetype)exceptionWithName:(NSString *)name;
+ (instancetype)exception;
- (instancetype)initWithName:(NSString *)name reason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (instancetype)initWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;

#pragma mark -
#pragma mark Creating Source Exception (SCL-20061)
+ (instancetype)sourceExceptionWithName:(NSString *)name;
+ (instancetype)sourceException;

#pragma mark -
#pragma mark Creating Incorrect Input Stream Exception (SCL-20062)
+ (instancetype)exceptionWithInputStream:(SCStream *)stream name:(NSString *)name;
+ (instancetype)exceptionWithInputStream:(SCStream *)stream;

#pragma mark -
#pragma mark Creating Read Only Exception (SCL-20063)
+ (instancetype)readOnlyExceptionWithName:(NSString *)name;
+ (instancetype)readOnlyException;

#pragma mark -
#pragma mark Creating Empty String Exceptions (SCL-20064)
+ (instancetype)emptyStringExceptionWithName:(NSString *)name;
+ (instancetype)emptyStringException;

#pragma mark -
#pragma mark Creating Closed Stream Exception (SCL-20065)
+ (instancetype)exceptionWithClosedStream:(SCStream *)stream name:(NSString *)name;
+ (instancetype)exceptionWithClosedStream:(SCStream *)stream;

#pragma mark -
#pragma mark Creating Unsupported Class Exception (SCL-20066)
+ (instancetype)exceptionWithUnsupported:(NSString *)unsupported name:(NSString *)name;
+ (instancetype)exceptionWithUnsupported:(NSString *)unsupported;

#pragma mark -
#pragma mark Creating Reading Error Exception (SCL-20067)
+ (instancetype)readErrorExceptionWithStream:(SCStream *)stream name:(NSString *)name;
+ (instancetype)readErrorExceptionWithStream:(SCStream *)stream;

#pragma mark -
#pragma mark Creating Empty Path Exception (SCL-20068)
+ (instancetype)emptyPathExceptionWithName:(NSString *)name;
+ (instancetype)emptyPathException;

#pragma mark -
#pragma mark Creating String Unique Violation Exception (SCL-20069)
+ (instancetype)duplicateExceptionWithName:(NSString *)name string:(NSString *)string index:(SCIndex)index;
+ (instancetype)duplicateExceptionWithString:(NSString *)string index:(SCIndex)index;

#pragma mark -
#pragma mark Creating Incorrect Sorter Exception (SCL-20070)
+ (instancetype)sorterExceptionWithName:(NSString *)name;
+ (instancetype)sorterException;

#pragma mark -
#pragma mark Creating Incorrect Output Stream Exception (SCL-20071)
+ (instancetype)exceptionWithOutputStream:(SCStream *)stream name:(NSString *)name;
+ (instancetype)exceptionWithOutputStream:(SCStream *)stream;

#pragma mark -
#pragma mark Creating Incorrect Index Exception (SCL-20072)
+ (instancetype)exceptionWithIndex:(SCIndex)index name:(NSString *)name;
+ (instancetype)exceptionWithIndex:(SCIndex)index;

#pragma mark -
#pragma mark Creating Incorrect Range Exception (SCL-20073)
+ (instancetype)exceptionWithRange:(NSRange)range name:(NSString *)name;
+ (instancetype)exceptionWithRange:(NSRange)range;

#pragma mark -
#pragma mark Creating Incorrect Index Set Exception (SCL-20074)
+ (instancetype)exceptionWithIndexSet:(NSIndexSet *)indexSet name:(NSString *)name;
+ (instancetype)exceptionWithIndexSet:(NSIndexSet *)indexSet;

#pragma mark -
#pragma mark Creating Indexes and Strings Count Exception (SCL-20075)
+ (instancetype)exceptionWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount name:(NSString *)name;
+ (instancetype)exceptionWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount;

#pragma mark -
#pragma mark Creating Intersected Ranges Exception (SCL-20076)
+ (instancetype)exceptionWithRange:(NSRange)range intersected:(NSRange)intersected name:(NSString *)name;
+ (instancetype)exceptionWithRange:(NSRange)range intersected:(NSRange)intersected;

#pragma mark -
#pragma mark Creating Writing Exception (SCL-20077)
+ (instancetype)writeErrorExceptionWithStream:(SCStream *)stream name:(NSString *)name;
+ (instancetype)writeErrorExceptionWithStream:(SCStream *)stream;

@end