OFMutableDictionary.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFDictionary.h"
 
OF_ASSUME_NONNULL_BEGIN

 
#ifdef OF_HAVE_BLOCKS
typedef id _Nonnull (^OFDictionaryReplaceBlock)(id key, id object);
#endif

@interface OFMutableDictionary OF_GENERIC(KeyType, ObjectType):
    OFDictionary OF_GENERIC(KeyType, ObjectType)
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define KeyType id
# define ObjectType id
#endif
+ (instancetype)dictionaryWithCapacity: (size_t)capacity;

- (instancetype)init OF_DESIGNATED_INITIALIZER;

- (instancetype)initWithCapacity: (size_t)capacity OF_DESIGNATED_INITIALIZER;

- (void)setObject: (ObjectType)object forKey: (KeyType)key;

- (void)setObject: (nullable ObjectType)object forKeyedSubscript: (KeyType)key;

- (void)removeObjectForKey: (KeyType)key;

- (void)removeAllObjects;

- (void)addEntriesFromDictionary:
    (OFDictionary OF_GENERIC(KeyType, ObjectType) *)dictionary;
 
#ifdef OF_HAVE_BLOCKS
- (void)replaceObjectsUsingBlock: (OFDictionaryReplaceBlock)block;
#endif

- (void)makeImmutable;
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef KeyType
# undef ObjectType
#endif
@end
 
OF_ASSUME_NONNULL_END