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
75
76
77
78
79
80
|
// Copyright 2014 Google Inc. 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.actions;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.Map;
import javax.annotation.Nullable;
/**
* An interface for resolving artifact names to {@link Artifact} objects. Should only be used
* in the internal machinery of Blaze: rule implementations are not allowed to do this.
*/
public interface ArtifactResolver {
/**
* Returns the source Artifact for the specified path, creating it if not found and setting its
* root and execPath.
*
* @param execPath the path of the source artifact relative to the source root
* @param root the source root prefix of the path
* @param owner the artifact owner.
* @return the canonical source artifact for the given path
*/
Artifact getSourceArtifact(PathFragment execPath, Root root, ArtifactOwner owner);
/**
* Returns the source Artifact for the specified path, creating it if not found and setting its
* root and execPath.
*
* @see #getSourceArtifact(PathFragment, Root, ArtifactOwner)
*/
Artifact getSourceArtifact(PathFragment execPath, Root root);
/**
* Resolves a source Artifact given an execRoot-relative path.
*
* <p>Never creates or returns derived artifacts, only source artifacts.
*
* <p>Note: this method should only be used when the roots are unknowable, such as from the
* post-compile .d or manifest scanning methods.
*
* @param execPath the exec path of the artifact to resolve
* @return an existing or new source Artifact for the given execPath. Returns null if
* the root can not be determined and the artifact did not exist before.
*/
Artifact resolveSourceArtifact(PathFragment execPath);
/**
* Resolves source Artifacts given execRoot-relative paths.
*
* <p>Never creates or returns derived artifacts, only source artifacts.
*
* <p>Note: this method should only be used when the roots are unknowable, such as from the
* post-compile .d or manifest scanning methods.
*
* @param execPaths list of exec paths of the artifacts to resolve
* @param resolver object that helps to resolve package root of given paths
* @return map which contains list of execPaths and corresponding Artifacts. Map can contain
* existing or new source Artifacts for the given execPaths. The artifact is null if the
* root cannot be determined and the artifact did not exist before. Return null if any
* dependencies are missing.
* @throws PackageRootResolutionException failure to determine package roots of {@code execPaths}
*/
@Nullable
Map<PathFragment, Artifact> resolveSourceArtifacts(Iterable<PathFragment> execPaths,
PackageRootResolver resolver) throws PackageRootResolutionException;
}
|
