IGListKit/Source/Common/IGListIndexSetResult.h
Bofei Zhu 8a645139b2 - (BOOL) hasChanges should be a readonly property
Summary:
Closed #402

- [x] All tests pass. Demo project builds and runs.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
Closes https://github.com/Instagram/IGListKit/pull/453

Differential Revision: D4479611

Pulled By: rnystrom

fbshipit-source-id: 4c93ce30613e45c19478f9f5d0e59eeeb0142766
2017-02-02 09:59:05 -08:00

86 lines
2.1 KiB
Objective-C

/**
* Copyright (c) 2016-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
#import <Foundation/Foundation.h>
#import <IGListKit/IGListMoveIndex.h>
NS_ASSUME_NONNULL_BEGIN
/**
A result object returned when diffing with indexes.
*/
@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