SCTextException.h

Go to the documentation of this file.

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

#import <scl/SCException.h>
#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Константы класса

#define SCTextExceptionCalss    @"SCTextException"
#define SCTextErrorName         @"SCText"

#pragma mark -
#pragma mark Константы ошибок

#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 Типы поддержки класса

enum _SCTextError {
    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,
};

typedef enum _SCTextError SCTextError;

@interface SCTextException : SCException {
    NSString    *fTextName;     // Название текста
    NSString    *fString;       // Ошибочная строка
    SCIndex      fIndex;        // Ошибочный индекс
    NSIndexSet  *fIndexSet;     // Недопустимый список индексов строк
    NSString    *fUnsupported;  // Название неподдерживаемого класса
    SCULong      fIndexesCount; // Количество индексов
    SCULong      fStringsCount; // Количество строк
    NSRange      fRange;        // Недопустимый диапазон строк
    NSRange      fIntersected;  // Пересекающийся диапазон
    SCStream    *fStream;       // Ошибочный поток
}
@property (nonatomic, retain, readonly, getter=textName) NSString *textName;

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

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

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

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

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

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

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

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

@property (nonatomic, assign, readonly, getter=stream) SCStream *stream;

#pragma mark -
#pragma mark Доступ к свойствам экземпляра класса
- (NSString *)textName;
- (NSString *)string;
- (SCIndex)index;
- (NSIndexSet *)indexSet;
- (NSString *)unsupported;
- (SCULong)indexesCount;
- (SCULong)stringsCount;
- (NSRange)range;
- (NSRange)intersected;
- (SCStream *)stream;

#pragma mark -
#pragma mark Создание и инициализация общих видов исключительных ситуаций
// SCL-20060
+ (SCTextException *)exceptionWithName:(NSString *)name
                                reason:(NSString *)reason
                                  code:(SCInteger)code
                                   eid:(NSString *)eid;
+ (SCTextException *)exceptionWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (SCTextException *)exceptionWithName:(NSString *)name;
+ (SCTextException *)exception;
- (id)initWithName:(NSString *)name reason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (id)initWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
- (id)initWithName:(NSString *)name;
- (id)init;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несуществующего исходного объекта
// SCL-20061
+ (SCTextException *)sourceExceptionWithName:(NSString *)name;
+ (SCTextException *)sourceException;
- (id)initSourceExceptionWithName:(NSString *)name;
- (id)initSourceException;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации некорректного входного потока
// SCL-20062
+ (SCTextException *)exceptionWithInputStream:(SCStream *)stream name:(NSString *)name;
+ (SCTextException *)exceptionWithInputStream:(SCStream *)stream;
- (id)initWithInputStream:(SCStream *)stream name:(NSString *)name;
- (id)initWithInputStream:(SCStream *)stream;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации нарушения режима только для чтения
// SCL-20063
+ (SCTextException *)readOnlyExceptionWithName:(NSString *)name;
+ (SCTextException *)readOnlyException;
- (id)initReadOnlyWithName:(NSString *)name;
- (id)initReadOnly;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации добавления нулевой строки
// SCL-20064
+ (SCTextException *)emptyStringExceptionWithName:(NSString *)name;
+ (SCTextException *)emptyStringException;
- (id)initEmptyStringWithName:(NSString *)name;
- (id)initEmptyString;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации закрытого потока
// SCL-20065
+ (SCTextException *)exceptionWithClosedStream:(SCStream *)stream name:(NSString *)name;
+ (SCTextException *)exceptionWithClosedStream:(SCStream *)stream;
- (id)initWithClosedStream:(SCStream *)stream name:(NSString *)name;
- (id)initWithClosedStream:(SCStream *)stream;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неподдерживаемого класса
// SCL-20066
+ (SCTextException *)exceptionWithUnsupported:(NSString *)unsupported name:(NSString *)name;
+ (SCTextException *)exceptionWithUnsupported:(NSString *)unsupported;
- (id)initWithUnsupported:(NSString *)unsupported name:(NSString *)name;
- (id)initWithUnsupported:(NSString *)unsupported;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации ошибки чтения данных из потока
// SCL-20067
+ (SCTextException *)readErrorExceptionWithStream:(SCStream *)stream name:(NSString *)name;
+ (SCTextException *)readErrorExceptionWithStream:(SCStream *)stream;
- (id)initReadErrorWithStream:(SCStream *)stream name:(NSString *)name;
- (id)initReadErrorWithStream:(SCStream *)stream;

#pragma mark -
#pragma mark Создания и инициализация исключительной ситуации пустого пути к текстовому файлу
// SCL-20068
+ (SCTextException *)emptyPathExceptionWithName:(NSString *)name;
+ (SCTextException *)emptyPathException;
- (id)initEmptyPathExceptionWithName:(NSString *)name;
- (id)initEmptyPathException;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации нарушения уникальности строк
// SCL-20069
+ (SCTextException *)duplicateExceptionWithName:(NSString *)name string:(NSString *)string index:(SCIndex)index;
+ (SCTextException *)duplicateExceptionWithString:(NSString *)string index:(SCIndex)index;
- (id)initDuplicateWithName:(NSString *)name string:(NSString *)string index:(SCIndex)index;
- (id)initDuplicateWithString:(NSString *)string index:(SCIndex)index;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации некорректного сортировщика строк
// SCL-20070
+ (SCTextException *)sorterExceptionWithName:(NSString *)name;
+ (SCTextException *)sorterException;
- (id)initSorterExceptionWithName:(NSString *)name;
- (id)initSorterException;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации некорректного выходного потока
//SCL-20071
+ (SCTextException *)exceptionWithOutputStream:(SCStream *)stream name:(NSString *)name;
+ (SCTextException *)exceptionWithOutputStream:(SCStream *)stream;
- (id)initWithOutputStream:(SCStream *)stream name:(NSString *)name;
- (id)initWithOutputStream:(SCStream *)stream;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации недопустимого индекса
// SCL-20072
+ (SCTextException *)exceptionWithIndex:(SCIndex)index name:(NSString *)name;
+ (SCTextException *)exceptionWithIndex:(SCIndex)index;
- (id)initWithIndex:(SCIndex)index name:(NSString *)name;
- (id)initWithIndex:(SCIndex)index;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации недопустимого диапазона строк
// SCL-20073
+ (SCTextException *)exceptionWithRange:(NSRange)range name:(NSString *)name;
+ (SCTextException *)exceptionWithRange:(NSRange)range;
- (id)initWithRange:(NSRange)range name:(NSString *)name;
- (id)initWithRange:(NSRange)range;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации недопустимого списка индексов строк
// SCL-20074
+ (SCTextException *)exceptionWithIndexSet:(NSIndexSet *)indexSet name:(NSString *)name;
+ (SCTextException *)exceptionWithIndexSet:(NSIndexSet *)indexSet;
- (id)initWithIndexSet:(NSIndexSet *)indexSet name:(NSString *)name;
- (id)initWithIndexSet:(NSIndexSet *)indexSet;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несоответствия количества индексов и строк
// SCL-20075
+ (SCTextException *)exceptionWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount name:(NSString *)name;
+ (SCTextException *)exceptionWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount;
- (id)initWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount name:(NSString *)name;
- (id)initWithIndexesCount:(SCULong)icount stringsCount:(SCULong)scount;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации пересекающихся диапазонов строк
// SCL-20076
+ (SCTextException *)exceptionWithRange:(NSRange)range intersected:(NSRange)intersected name:(NSString *)name;
+ (SCTextException *)exceptionWithRange:(NSRange)range intersected:(NSRange)intersected;
- (id)initWithRange:(NSRange)range intersected:(NSRange)intersected name:(NSString *)name;
- (id)initWithRange:(NSRange)range intersected:(NSRange)intersected;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации ошибки записи данных в поток
// SCL-20077
+ (SCTextException *)writeErrorExceptionWithStream:(SCStream *)stream name:(NSString *)name;
+ (SCTextException *)writeErrorExceptionWithStream:(SCStream *)stream;
- (id)initWriteErrorWithStream:(SCStream *)stream name:(NSString *)name;
- (id)initWriteErrorWithStream:(SCStream *)stream;

@end