ThreatInfo.h

//
//  ThreatInfo.h
//
//  Created by Andreea ERDELYI <andreea.erdelyi@cososys.com>
//
//  Copyright (C) 2017 CoSoSys Ltd team@sensitivity.io
//  CoSoSys Ltd. All rights reserved.
//  Please see the COPYING for more details.
//

#import <Foundation/Foundation.h>
#import <sensitivityio/c_sds/sds_threat_type.h>

@class ThreatLocation;

// MARK: - ThreatInfo
@interface ThreatInfo : NSObject

- (instancetype _Null_unspecified) init NS_UNAVAILABLE;
+ (instancetype _Null_unspecified) new NS_UNAVAILABLE;
- (instancetype _Null_unspecified) copy NS_UNAVAILABLE;
- (instancetype _Nullable) initWithError:(NSError * _Nullable * _Nullable)error NS_DESIGNATED_INITIALIZER NS_SWIFT_NAME(init());

// MARK: - setters

- (BOOL) setTypeId:(sensitivityio_sds_threat_type_id_t)typeId withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setMatchedText:(NSString* _Nonnull)matchedText withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setThreatDescription:(NSString* _Nonnull)threatDescription withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setlocation:(ThreatLocation* _Nonnull)location withError:(NSError * _Nullable * _Nullable)error;

// MARK: - getters

- (BOOL) typeId:(sensitivityio_sds_threat_type_id_t* _Nonnull)typeId withError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) typeNameWithError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) matchedTextWithError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) maskedMatchedTextWithError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) threatDescriptionWithError:(NSError * _Nullable * _Nullable)error;
- (ThreatLocation* _Nullable) locationWithError:(NSError * _Nullable * _Nullable)error;

// MARK: - description

- (NSString* _Nonnull) description;

// MARK: - class methods

+ (NSString* _Nonnull) typeNameForThreatTypeId:(sensitivityio_sds_threat_type_id_t)threatTypeId NS_SWIFT_NAME(typeName(threatTypeId:));

+ (NSString* _Nonnull) maskMatchedText:(NSString* _Nonnull)matchedText forThreatTypeId:(sensitivityio_sds_threat_type_id_t)threatTypeId NS_SWIFT_NAME(mask(matchedText:threatTypeId:));

@end