IGListKit/Source/Common/IGListIndexSetResult.h
Ryan Nystrom 000bc36919 Relicense to MIT
Summary: Relicensing IGListKit under MIT

Reviewed By: calimarkus

Differential Revision: D7764125

fbshipit-source-id: 6c773195ef3184202725fe7f08de754f979cb83f
2018-05-01 14:50:56 -07:00

85 lines
2 KiB
Objective-C

/**
* Copyright (c) 2016-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#import <Foundation/Foundation.h>
#import <IGListKit/IGListMoveIndex.h>
NS_ASSUME_NONNULL_BEGIN
/**
A result object returned when diffing with indexes.
*/
NS_SWIFT_NAME(ListIndexSetResult)
@interface IGListIndexSetResult : NSObject
/**
The indexes inserted into the new collection.
*/
@property (nonatomic, strong, readonly) NSIndexSet *inserts;
/**
The indexes deleted from the old collection.
*/
@property (nonatomic, strong, readonly) NSIndexSet *deletes;
/**
The indexes in the old collection that need updated.
*/
@property (nonatomic, strong, readonly) NSIndexSet *updates;
/**
The moves from an index in the old collection to an index in the new collection.
*/
@property (nonatomic, copy, readonly) NSArray<IGListMoveIndex *> *moves;
/**
A Read-only boolean that indicates whether the result has any changes or not.
`YES` if the result has changes, `NO` otherwise.
*/
@property (nonatomic, assign, readonly) BOOL hasChanges;
/**
Returns the index of the object with the specified identifier *before* the diff.
@param identifier The diff identifier of the object.
@return The index of the object before the diff, or `NSNotFound`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (NSInteger)oldIndexForIdentifier:(id<NSObject>)identifier;
/**
Returns the index of the object with the specified identifier *after* the diff.
@param identifier The diff identifier of the object.
@return The index path of the object after the diff, or `NSNotFound`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (NSInteger)newIndexForIdentifier:(id<NSObject>)identifier;
/**
Creates a new result object with operations safe for use in `UITableView` and `UICollectionView` batch updates.
*/
- (IGListIndexSetResult *)resultForBatchUpdates;
/**
:nodoc:
*/
- (instancetype)init NS_UNAVAILABLE;
/**
:nodoc:
*/
+ (instancetype)new NS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END