blob: 895240a197e0d582ad2e7327f307461ff4370e1a (
plain)
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
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// 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 com.google.devtools.build.lib.packages;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkbuildapi.ProviderApi;
import com.google.devtools.build.lib.syntax.ClassObject;
/**
* Declared Provider (a constructor for {@link Info}).
*
* <p>Declared providers can be declared either natively ({@link NativeProvider} or in Skylark
* {@link SkylarkProvider}.
*
* <p>{@link Provider} serves both as "type identifier" for declared provider instances and as a
* function that can be called to construct a provider. To the Skylark user, there are "providers"
* and "provider instances"; the former is a Java instance of this class, and the latter is a Java
* instance of {@link Info}.
*
* <p>Prefer to use {@link Key} as a serializable identifier of {@link Provider}. In particular,
* {@link Key} should be used in all data structures exposed to Skyframe.
*/
@Immutable
public interface Provider extends ProviderApi {
/**
* Has this {@link Provider} been exported? All native providers are always exported. Skylark
* providers are exported if they are assigned to top-level name in a Skylark module.
*/
boolean isExported();
/** Returns a serializable representation of this {@link Provider}. */
Key getKey();
/** Returns a name of this {@link Provider} that should be used in error messages. */
String getPrintableName();
/**
* Returns an error message format string for instances to use for their {@link
* ClassObject#getErrorMessageForUnknownField(String)}.
*
* <p>The format string must contain one {@code '%s'} placeholder for the field name.
*/
default String getErrorMessageFormatForUnknownField() {
return String.format("'%s' object has no attribute '%%s'", getPrintableName());
}
/**
* Returns the location at which provider was defined.
*/
Location getLocation();
/** A serializable representation of {@link Provider}. */
public abstract static class Key {}
}
|
