ThreatLocation.h

//
//  ThreatLocation.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>

@interface ThreatLocation : 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) setFileName:(NSString* _Nonnull)fileName withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setArchiveMember:(NSString* _Nonnull)archiveMember withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setOffset:(NSNumber* _Nonnull)offset withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setLineNumber:(NSInteger)lineNumber withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setSurroundingText:(NSString* _Nonnull)surroundingText withError:(NSError * _Nullable * _Nullable)error;
- (BOOL) setInMetadata:(BOOL)inMetadata withError:(NSError * _Nullable * _Nullable)error;

// MARK: - getters

- (NSString* _Nullable) fileNameWithError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) archiveMemberWithError:(NSError * _Nullable * _Nullable)error;
- (NSNumber* _Nullable) offsetWithError:(NSError * _Nullable * _Nullable)error;
- (BOOL) lineNumber:(NSInteger* _Nonnull)lineNumber withError:(NSError * _Nullable * _Nullable)error;
- (NSString* _Nullable) surroundingTextWithError:(NSError * _Nullable * _Nullable)error;

- (BOOL) inMetadata:(BOOL* _Nonnull)inMetadata withError:(NSError * _Nullable * _Nullable)error;

// MARK: - description

- (NSString* _Nonnull) description;

@end