-
Notifications
You must be signed in to change notification settings - Fork 741
/
GREYMatcher.h
74 lines (64 loc) · 2.53 KB
/
GREYMatcher.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
//
// Copyright 2016 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#import <Foundation/Foundation.h>
#import <EarlGrey/GREYDescription.h>
NS_ASSUME_NONNULL_BEGIN
/**
* Matchers are another way of expressing simple or complex logical expressions. This protocol
* defines a set of methods that must be implemented by every matcher object.
*/
@protocol GREYMatcher<NSObject>
/**
* A method to evaluate the matcher for the provided @c item.
*
* @param item The object which is to be evaluated against the matcher.
*
* @return @c YES if the object matched the matcher, @c NO otherwise.
*/
- (BOOL)matches:(_Nullable id)item;
/**
* A method to evaluate the matcher for the provided @c item with a description for the issue
* in case of a mismatch.
*
* @param item The object which is to be evaluated against the matcher.
*
* @param mismatchDescription The description that is built or appended if the provided @c item
* does not match the matcher.
*
* @return @c YES if the object matched the matcher, @c NO otherwise. In case of a mismatch, the
* reason for mismatch is added to @c mismatchDescription.
*/
- (BOOL)matches:(_Nullable id)item describingMismatchTo:(id<GREYDescription>)mismatchDescription;
/**
* A method to generate the description containing the reason for why a matcher did not match an
* item.
*
* @param item The object which is to be evaluated against the matcher.
*
* @param mismatchDescription The description that is built or appended if the provided @c item
* does not match the matcher.
*
* @remark This method assumes that GREYMatcher::matches: is false, but will not check this.
*/
- (void)describeMismatchOf:(_Nullable id)item to:(id<GREYDescription>)mismatchDescription;
/**
* A method to generate a description of an object.
*
* @param description The description that is built or appended.
*/
- (void)describeTo:(id<GREYDescription>)description;
@end
NS_ASSUME_NONNULL_END