-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
MultipleCandidatesDetails.java
53 lines (48 loc) · 1.68 KB
/
MultipleCandidatesDetails.java
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
/*
* Copyright 2016 the original author or authors.
*
* 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.
*/
package org.gradle.api.attributes;
import javax.annotation.Nullable;
import java.util.Set;
/**
* Provides context about candidates for an attribute. In particular, this class gives access to
* the list of candidates on the producer side.
*
* @param <T> the concrete type of the attribute
* @since 3.3
*/
public interface MultipleCandidatesDetails<T> {
/**
* Returns the value of the attribute specified by the consumer.
*
* @return The value or {@code null} if the consumer did not specify a value.
* @since 4.1
*/
@Nullable
T getConsumerValue();
/**
* A set of candidate values.
*
* @return the set of candidates
*/
Set<T> getCandidateValues();
/**
* Calling this method indicates that the candidate is the closest match. It is allowed to call this method several times with
* different values, in which case it indicates that multiple candidates are equally compatible.
*
* @param candidate The closest match. Must be present in {@link #getCandidateValues()}.
*/
void closestMatch(T candidate);
}