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 <Foundation/Foundation.h>
#import <scl/SCCollectionProtocols.h>
#import <scl/SCException.h>

#pragma mark -
#pragma mark Class Constants

#define SCCollectionExceptionClass      @"SCCollectionException"

#define SCCollectionErrorName           @"SCCollection"


#pragma mark -
#pragma mark Error ID Contants

#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 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 Class Support Types

typedef enum {
    SCCollectionErrorUnspecified        = -20040,
    
    SCCollectionErrorSource             = -20041,
    
    SCCollectionErrorType               = -20042,
    
    SCCollectionErrorReadOnly           = -20043,
    
    SCCollectionErrorItem               = -20044,
    
    SCCollectionErrorObject             = -20045,

    SCCollectionErrorUnsupported        = -20046,
    
    SCCollectionErrorUnknown            = -20047,
    
    SCCollectionErrorNotComparable      = -20048,
    
    SCCollectionErrorNotSortable        = -20049,
    
    SCCollectionErrorSorter             = -20050,
    
    SCCollectionErrorIndex              = -20052,
    
    SCCollectionErrorRange              = -20053,
    
    SCCollectionErrorIndexSet           = -20054,
    
    SCCollectionErrorIndexSetCount      = -20055,
    
    SCCollectionErrorKey                = -20056,
    
    SCCollectionErrorKeysCount          = -20057,
    
    SCCollectionErrorValue              = -20058,

} SCCollectionError;


#pragma mark -

@interface SCCollectionException : SCException {
    NSString    *fCollectionName;   // Collection name
    NSString    *fTypeName;         // Name of the unsupported collection type
    NSString    *fUnsupported;      // Unsupported class name
    NSString    *fUnknown;          // Unknown clas name
    SCIndex      fIndex;            // Incorrect index
    NSRange      fRange;            // Incorrect reange of the objects
    NSIndexSet  *fIndexSet;         // Incorrect index set
    SCULong      fIndexesCount;     // Number of the indexes
    SCULong      fObjectsCount;     // Number of the objects
    NSString    *fKey;              // Incorrect object key
    SCULong      fKeysCount;        // Number of the keys
}
#pragma mark -
#pragma mark Instance Properties

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

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

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

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

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

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

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

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

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

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

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

#pragma mark -
#pragma mark Creating and Initializing the Generic Collection Exceptions
+ (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;
- (instancetype)initWithName:(NSString *)name;
- (instancetype)init;

#pragma mark -
#pragma mark Creating and Initializing Source Exception (SCL-20041)
+ (instancetype)exceptionWithSource;
- (instancetype)initWithSource;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Collection Type Exception (SCL-20042)
+ (instancetype)exceptionWithUnsupportedType:(NSString *)type;
- (instancetype)initWithUnsupportedType:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Read Only Exception (SCL-20043)
+ (instancetype)exceptionWithReadOnlyType:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithReadOnlyType:(NSString *)type;
- (instancetype)initWithReadOnlyType:(NSString *)type name:(NSString *)name;
- (instancetype)initWithReadOnlyType:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Null Object Exception (SCL-20044)
+ (instancetype)exceptionWithItemType:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithItemType:(NSString *)type;
- (instancetype)initWithItemType:(NSString *)type name:(NSString *)name;
- (instancetype)initWithItemType:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Source Object Exception (SCL-20045)
+ (instancetype)exceptionWithObject;
- (instancetype)initWithObject;

#pragma mark -
#pragma mark Creating and Initializing Unsupported Class Exception (SCL-20046)
+ (instancetype)exceptionWithUnsupported:(NSString *)cname type:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithUnsupported:(NSString *)cname type:(NSString *)type;
- (instancetype)initWithUnsupported:(NSString *)cname type:(NSString *)type name:(NSString *)name;
- (instancetype)initWithUnsupported:(NSString *)cname type:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Unknown Class Exception (SCL-20047)
+ (instancetype)exceptionWithUnknown:(NSString *)cname type:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithUnknown:(NSString *)cname type:(NSString *)type;
- (instancetype)initWithUnknown:(NSString *)cname type:(NSString *)type name:(NSString *)name;
- (instancetype)initWithUnknown:(NSString *)cname type:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Incomparable Object Exception (SCL-20048)
+ (instancetype)exceptionWithNotComparableType:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithNotComparableType:(NSString *)type;
- (instancetype)initWithNotComparableType:(NSString *)type name:(NSString *)name;
- (instancetype)initWithNotComparableType:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Unsortable Collection Exception (SCL-20049)
+ (instancetype)exceptionWithNotSortableType:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithNotSortableType:(NSString *)type;
- (instancetype)initWithNotSortableType:(NSString *)type name:(NSString *)name;
- (instancetype)initWithNotSortableType:(NSString *)type;

#pragma mark -
#pragma mark Creating and Initializing Incorrect Sorter Exception (SCL-20050)
+ (instancetype)exceptionWithSorterType:(NSString *)type name:(NSString *)name;
+ (instancetype)exceptionWithSorterType:(NSString *)type;
- (instancetype)initWithSorterType:(NSString *)type name:(NSString *)name;
- (instancetype)initWithSorterType:(NSString *)type;

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

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

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

#pragma mark -
#pragma mark Creating and Initializing Indexes and Objects Count Exception (SCL-20055)
+ (instancetype)exceptionWithIndexesCount:(SCULong)indexes objectsCount:(SCULong)objects;
- (instancetype)initWithIndexesCount:(SCULong)indexes objectsCount:(SCULong)objects;

#pragma mark -
#pragma mark Creating and Initializing Incorrect Key Exception (SCL-20056)
+ (instancetype)exceptionWithKey:(NSString *)key name:(NSString *)name;
+ (instancetype)exceptionWithKey:(NSString *)key;
- (instancetype)initWithKey:(NSString *)key name:(NSString *)name;
- (instancetype)initWithKey:(NSString *)key;

#pragma mark -
#pragma mark Creating and Initializing Keys and Objects Count Exception (SCL-20057)
+ (instancetype)exceptionWithKeysCount:(SCULong)keys objectsCount:(SCULong)objects;
- (instancetype)initWithKeysCount:(SCULong)keys objectsCount:(SCULong)objects;

#pragma mark -
#pragma mark Creating and Initializing Empty Value Exception (SCL-20058)
+ (instancetype)exceptionValueForKey:(NSString *)key name:(NSString *)name;
+ (instancetype)exceptionValueForKey:(NSString *)key;
- (instancetype)initValueForKey:(NSString *)key name:(NSString *)name;
- (instancetype)initValueForKey:(NSString *)key;

@end