blob: 9cd9d7961b1d4dfa2f3acfb85c0d419b5918611b (
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// Copyright 2018 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.skyframe;
import com.google.common.collect.Interner;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.concurrent.BlazeInterners;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.devtools.build.skyframe.AbstractSkyKey;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
/**
* Encapsulates the errors, if any, encountered when loading a specific package.
*
* <p>This is a change-pruning-friendly convenience {@link SkyValue} for use cases where {@link
* Result} is sufficient.
*/
public abstract class PackageErrorMessageValue implements SkyValue {
/** Tri-state result of loading the package. */
enum Result {
/**
* There was no error loading the package and {@link
* com.google.devtools.build.lib.packages.Package#containsErrors} returned {@code false}.
*/
NO_ERROR,
/**
* There was no error loading the package and {@link
* com.google.devtools.build.lib.packages.Package#containsErrors} returned {@code true}.
*/
ERROR,
/**
* There was a {@link com.google.devtools.build.lib.packages.NoSuchPackageException} loading the
* package.
*/
NO_SUCH_PACKAGE_EXCEPTION,
}
/** Returns the {@link Result} from loading the package. */
abstract Result getResult();
/**
* If {@code getResult().equals(NO_SUCH_PACKAGE_EXCEPTION)}, returns the error message from the
* {@link com.google.devtools.build.lib.packages.NoSuchPackageException} encountered.
*/
abstract String getNoSuchPackageExceptionMessage();
static PackageErrorMessageValue ofPackageWithNoErrors() {
return NO_ERROR_VALUE;
}
static PackageErrorMessageValue ofPackageWithErrors() {
return ERROR_VALUE;
}
static PackageErrorMessageValue ofNoSuchPackageException(String errorMessage) {
return new NoSuchPackageExceptionValue(errorMessage);
}
static SkyKey key(PackageIdentifier pkgId) {
return Key.create(pkgId);
}
@AutoCodec.VisibleForSerialization
@AutoCodec
static class Key extends AbstractSkyKey<PackageIdentifier> {
private static final Interner<Key> interner = BlazeInterners.newWeakInterner();
private Key(PackageIdentifier arg) {
super(arg);
}
@AutoCodec.VisibleForSerialization
@AutoCodec.Instantiator
static Key create(PackageIdentifier arg) {
return interner.intern(new Key(arg));
}
@Override
public SkyFunctionName functionName() {
return SkyFunctions.PACKAGE_ERROR_MESSAGE;
}
}
@AutoCodec
static final PackageErrorMessageValue NO_ERROR_VALUE =
new PackageErrorMessageValue() {
@Override
Result getResult() {
return Result.NO_ERROR;
}
@Override
String getNoSuchPackageExceptionMessage() {
throw new IllegalStateException();
}
};
@AutoCodec
static final PackageErrorMessageValue ERROR_VALUE =
new PackageErrorMessageValue() {
@Override
Result getResult() {
return Result.ERROR;
}
@Override
String getNoSuchPackageExceptionMessage() {
throw new IllegalStateException();
}
};
@AutoCodec
static class NoSuchPackageExceptionValue extends PackageErrorMessageValue {
private final String errorMessage;
public NoSuchPackageExceptionValue(String errorMessage) {
this.errorMessage = errorMessage;
}
@Override
Result getResult() {
return Result.NO_SUCH_PACKAGE_EXCEPTION;
}
@Override
String getNoSuchPackageExceptionMessage() {
return errorMessage;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof NoSuchPackageExceptionValue)) {
return false;
}
NoSuchPackageExceptionValue other = (NoSuchPackageExceptionValue) obj;
return errorMessage.equals(other.errorMessage);
}
@Override
public int hashCode() {
return errorMessage.hashCode();
}
}
}
|
