SCCollectionException.h

Go to the documentation of this file.

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

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

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

#define SCCollectionExceptionClass      @"SCCollectionException"
#define SCCollectionErrorName           @"SCCollection"     

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

#define SCCollectionEIDUnspecified      @"SCL-20040"        
#define SCCollectionEIDSource           @"SCL-20041"        
#define SCCollectionEIDType             @"SCL-20042"        
#define SCCollectionEIDReadOnly         @"SCL-20043"
#define SCCollectionEIDItem             @"SCL-20044"        
#define SCCollectionEIDObject           @"SCL-20045"        
#define SCCollectionEIDUnsupported      @"SCL-20046"        
#define SCCollectionEIDUnknown          @"SCL-20047"        
#define SCCollectionEIDNotComparable    @"SCL-20048"        
#define SCCollectionEIDNotSortable      @"SCL-20049"        
#define SCCollectionEIDSorter           @"SCL-20050"        
#define SCCollectionEIDUnexpected       @"SCL-20051"        
#define SCCollectionEIDIndex            @"SCL-20052"        
#define SCCollectionEIDRange            @"SCL-20053"        
#define SCCollectionEIDIndexSet         @"SCL-20054"        
#define SCCollectionEIDIndexSetCount    @"SCL-20055"        
#define SCCollectionEIDKey              @"SCL-20056"        
#define SCCollectionEIDKeysCount        @"SCL-20057"        
#define SCCollectionEIDValue            @"SCL-20058"        

#pragma mark -
#pragma mark Типы поддержки класса

enum _SCCollectionError {
    SCCollectionErrorUnspecified        = -20040,
    SCCollectionErrorSource             = -20041,
    SCCollectionErrorType               = -20042,
    SCCollectionErrorReadOnly           = -20043,
    SCCollectionErrorItem               = -20044,
    SCCollectionErrorObject             = -20045,
    SCCollectionErrorUnsupported        = -20046,
    SCCollectionErrorUnknown            = -20047,
    SCCollectionErrorNotComparable      = -20048,
    SCCollectionErrorNotSortable        = -20049,
    SCCollectionErrorSorter             = -20050,
    SCCollectionErrorUnexpected         = -20051,
    SCCollectionErrorIndex              = -20052,
    SCCollectionErrorRange              = -20053,
    SCCollectionErrorIndexSet           = -20054,
    SCCollectionErrorIndexSetCount      = -20055,
    SCCollectionErrorKey                = -20056,
    SCCollectionErrorKeysCount          = -20057,
    SCCollectionErrorValue              = -20058,
};

typedef enum _SCCollectionError SCCollectionError;

#pragma mark -

@interface SCCollectionException : SCException {
    NSString    *fCollectionName;   // Название коллекции
    NSString    *fTypeName;         // Название неподдерживаемого типа коллекции
    NSString    *fUnsupported;      // Название неподдерживаемого класса
    NSString    *fUnknown;          // Название неизвестного класса
    NSString    *fUnexpected;       // Название неожиданного класса
    NSString    *fExpected;         // Название ожидавшегося класса
    SCIndex      fIndex;            // Недопустимый индекс
    NSRange      fRange;            // Недопустимый диапазон объектов
    NSIndexSet  *fIndexSet;         // Недопустимый список индексов
    SCULong      fIndexesCount;     // Количество индексов в списке
    SCULong      fObjectsCount;     // Количество объектов
    NSString    *fKey;              // Некорректный ключ объекта
    SCULong      fKeysCount;        // Количество ключей
}
#pragma mark -
#pragma mark Свойства экземпляра класса

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

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

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

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

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

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

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

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

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

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

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

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

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

#pragma mark -
#pragma mark Доступ к свойствам экземпляра класса
- (NSString *)collectionName;
- (NSString *)typeName;
- (NSString *)unsupported;
- (NSString *)unknown;
- (NSString *)unexpected;
- (NSString *)expected;
- (SCIndex)index;
- (NSRange)range;
- (NSIndexSet *)indexSet;
- (SCULong)indexesCount;
- (SCULong)objectsCount;
- (NSString *)key;
- (SCULong)keysCount;

#pragma mark -
#pragma mark Создание и инициализация общих видов исключительных ситуаций
+ (SCCollectionException *)exceptionWithName:(NSString *)name
                                      reason:(NSString *)reason
                                        code:(SCInteger)code
                                         eid:(NSString *)eid;
+ (SCCollectionException *)exceptionWithReason:(NSString *)reason code:(SCInteger)code eid:(NSString *)eid;
+ (SCCollectionException *)exceptionWithName:(NSString *)name;
+ (SCCollectionException *)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 Создание и инициализация исключительной ситуации несуществующей исходной коллекции
+ (SCCollectionException *)exceptionWithSource;
- (id)initWithSource;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неподдерживаемого типа коллекции
+ (SCCollectionException *)exceptionWithUnsupportedType:(NSString *)type;
- (id)initWithUnsupportedType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации нарушения режима только для чтения
+ (SCCollectionException *)exceptionWithReadOnlyType:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithReadOnlyType:(NSString *)type;
- (id)initWithReadOnlyType:(NSString *)type name:(NSString *)name;
- (id)initWithReadOnlyType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации добавления нулевого указателя
+ (SCCollectionException *)exceptionWithItemType:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithItemType:(NSString *)type;
- (id)initWithItemType:(NSString *)type name:(NSString *)name;
- (id)initWithItemType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несуществующего исходного объекта
+ (SCCollectionException *)exceptionWithObject;
- (id)initWithObject;

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

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неизвестного класса
+ (SCCollectionException *)exceptionWithUnknown:(NSString *)cname type:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithUnknown:(NSString *)cname type:(NSString *)type;
- (id)initWithUnknown:(NSString *)cname type:(NSString *)type name:(NSString *)name;
- (id)initWithUnknown:(NSString *)cname type:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несравнимых объектов
+ (SCCollectionException *)exceptionWithNotComparableType:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithNotComparableType:(NSString *)type;
- (id)initWithNotComparableType:(NSString *)type name:(NSString *)name;
- (id)initWithNotComparableType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несортируемой коллекции
+ (SCCollectionException *)exceptionWithNotSortableType:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithNotSortableType:(NSString *)type;
- (id)initWithNotSortableType:(NSString *)type name:(NSString *)name;
- (id)initWithNotSortableType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации сортировщика данных
+ (SCCollectionException *)exceptionWithSorterType:(NSString *)type name:(NSString *)name;
+ (SCCollectionException *)exceptionWithSorterType:(NSString *)type;
- (id)initWithSorterType:(NSString *)type name:(NSString *)name;
- (id)initWithSorterType:(NSString *)type;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации неожиданного класса
+ (SCCollectionException *)exceptionWithUnexpected:(NSString *)unexpected
                                          expected:(NSString *)expected
                                              type:(NSString *)type
                                              name:(NSString *)name;
+ (SCCollectionException *)exceptionWithUnexpected:(NSString *)unexpected
                                          expected:(NSString *)expected
                                              type:(NSString *)type;
- (id)initWithUnexpected:(NSString *)unexpected
                expected:(NSString *)expected
                    type:(NSString *)type
                    name:(NSString *)name;
- (id)initWithUnexpected:(NSString *)unexpected expected:(NSString *)expected type:(NSString *)type;

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

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

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

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несоответствия количества индексов и объектов
+ (SCCollectionException *)exceptionWithIndexesCount:(SCULong)indexes objectsCount:(SCULong)objects;
- (id)initWithIndexesCount:(SCULong)indexes objectsCount:(SCULong)objects;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации некорректного ключа объекта
+ (SCCollectionException *)exceptionWithKey:(NSString *)key name:(NSString *)name;
+ (SCCollectionException *)exceptionWithKey:(NSString *)key;
- (id)initWithKey:(NSString *)key name:(NSString *)name;
- (id)initWithKey:(NSString *)key;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации несоответствия количества ключей и объектов
+ (SCCollectionException *)exceptionWithKeysCount:(SCULong)keys objectsCount:(SCULong)objects;
- (id)initWithKeysCount:(SCULong)keys objectsCount:(SCULong)objects;

#pragma mark -
#pragma mark Создание и инициализация исключительной ситуации пустого значения
+ (SCCollectionException *)exceptionValueForKey:(NSString *)key name:(NSString *)name;
+ (SCCollectionException *)exceptionValueForKey:(NSString *)key;
- (id)initValueForKey:(NSString *)key name:(NSString *)name;
- (id)initValueForKey:(NSString *)key;

@end