CBLProperties.h

Go to the documentation of this file.

//
//  CBLProperties.h
//  CouchbaseLite
//
//  Created by Pasin Suriyentrakorn on 12/29/16.
//  Copyright © 2016 Couchbase. All rights reserved.
//

#import <Foundation/Foundation.h>
@class CBLSubdocument;

NS_ASSUME_NONNULL_BEGIN

@protocol CBLProperties <NSObject>

@property (readwrite, nullable, nonatomic) NSDictionary* properties;

#pragma mark - GETTERS

- (nullable id) objectForKey: (NSString*)key;

- (BOOL) booleanForKey: (NSString*)key;

- (NSInteger) integerForKey: (NSString*)key;

- (float) floatForKey: (NSString*)key;

- (double) doubleForKey: (NSString*)key;

- (nullable NSString*) stringForKey: (NSString*)key;

- (nullable NSDate*) dateForKey: (NSString*)key;

#pragma mark - SETTERS

- (void) setObject: (nullable id)value forKey: (NSString*)key;

- (void) setBoolean: (BOOL)value forKey: (NSString*)key;

- (void) setInteger: (NSInteger)value forKey: (NSString*)key;

- (void) setFloat: (float)value forKey: (NSString*)key;

- (void) setDouble: (double)value forKey: (NSString*)key;

#pragma mark - SUBSCRIPTS

- (nullable id) objectForKeyedSubscript: (NSString*)key;

- (void) setObject: (nullable id)value forKeyedSubscript: (NSString*)key;

#pragma mark - OTHERS

- (void) removeObjectForKey: (NSString*)key;

- (BOOL) containsObjectForKey: (NSString*)key;

@end


@interface CBLProperties: NSObject <CBLProperties>

- (instancetype) init NS_UNAVAILABLE;

@end

NS_ASSUME_NONNULL_END

// TODO:
// 1. Evaluate get/set Array of a specific type (new API)
// 2. Subdocument (In progress)
// 4. Property complex object (Can be deferred)
// 5. Iterable or ObjC Equivalent (Can be deferred)