IGListKit/Source/IGListDiffKit/IGListDiffable.h
Tim Oliver f92b9339ee Standarize the copyright notice in all source files
Summary:
The standardized Meta copyright notice is "Copyright (c) Meta Platforms, Inc. and affiliates." and not "Copyright (c) Meta Platforms, Inc. and its affiliates." (Dropping the "its")

This diff updates the copyright notice in each source file to the correct this.

Reviewed By: willbailey

Differential Revision: D44737667

fbshipit-source-id: 643bf36df76723e70d9d826c53cf8f29b8a0c8cc
2023-04-06 02:44:16 -07:00

38 lines
1.1 KiB
Objective-C

/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* 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>
/**
The `IGListDiffable` protocol provides methods needed to compare the identity and equality of two objects.
*/
NS_SWIFT_NAME(ListDiffable)
@protocol IGListDiffable
/**
Returns a key that uniquely identifies the object.
@return A key that can be used to uniquely identify the object.
@note Two objects may share the same identifier, but are not equal. A common pattern is to use the `NSObject`
category for automatic conformance. However this means that objects will be identified on their
pointer value so finding updates becomes impossible.
@warning This value should never be mutated.
*/
- (nonnull id<NSObject>)diffIdentifier;
/**
Returns whether the receiver and a given object are equal.
@param object The object to be compared to the receiver.
@return `YES` if the receiver and object are equal, otherwise `NO`.
*/
- (BOOL)isEqualToDiffableObject:(nullable id<IGListDiffable>)object;
@end