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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
// Copyright 2014 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.events;
import static java.nio.charset.StandardCharsets.ISO_8859_1;
import com.google.common.base.Preconditions;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Objects;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* An event is a situation encountered by the build system that's worth
* reporting: A 3-tuple of ({@link EventKind}, {@link Location}, message).
*/
@Immutable
public final class Event implements Serializable {
private final EventKind kind;
private final Location location;
private final String message;
/**
* An alternative representation for message.
* Exactly one of message or messageBytes will be non-null.
* If messageBytes is non-null, then it contains the bytes
* of the message, encoded using the platform's default charset.
* We do this to avoid converting back and forth between Strings
* and bytes.
*/
private final byte[] messageBytes;
@Nullable
private final String tag;
public Event withTag(String tag) {
if (this.message != null) {
return new Event(this.kind, this.location, this.message, tag);
} else {
return new Event(this.kind, this.location, this.messageBytes, tag);
}
}
public Event(EventKind kind, @Nullable Location location, String message) {
this(kind, location, message, null);
}
public Event(EventKind kind, @Nullable Location location, String message, @Nullable String tag) {
this.kind = kind;
this.location = location;
this.message = Preconditions.checkNotNull(message);
this.messageBytes = null;
this.tag = tag;
}
public Event(EventKind kind, @Nullable Location location, byte[] messageBytes) {
this(kind, location, messageBytes, null);
}
public Event(
EventKind kind, @Nullable Location location, byte[] messageBytes, @Nullable String tag) {
this.kind = kind;
this.location = location;
this.message = null;
this.messageBytes = Preconditions.checkNotNull(messageBytes);
this.tag = tag;
}
public String getMessage() {
return message != null ? message : new String(messageBytes);
}
public byte[] getMessageBytes() {
return messageBytes != null ? messageBytes : message.getBytes(ISO_8859_1);
}
public EventKind getKind() {
return kind;
}
/**
* the tag is typically the action that generated the event.
*/
@Nullable
public String getTag() {
return tag;
}
/**
* Returns the location of this event, if any. Returns null iff the event
* wasn't associated with any particular location, for example, a progress
* message.
*/
@Nullable public Location getLocation() {
return location;
}
/**
* Returns <i>some</i> moderately sane representation of the event. Should never be used in
* user-visible places, only for debugging and testing.
*/
@Override
public String toString() {
return kind + " " + (location != null ? location.print() : "<no location>") + ": "
+ getMessage();
}
@Override
public int hashCode() {
return Objects.hash(kind, location, message, tag, Arrays.hashCode(messageBytes));
}
@Override
public boolean equals(Object other) {
if (other == null || !other.getClass().equals(getClass())) {
return false;
}
Event that = (Event) other;
return Objects.equals(this.kind, that.kind)
&& Objects.equals(this.location, that.location)
&& Objects.equals(this.tag, that.tag)
&& Objects.equals(this.message, that.message)
&& Arrays.equals(this.messageBytes, that.messageBytes);
}
/**
* Replay a sequence of events on an {@link EventHandler}.
*/
public static void replayEventsOn(EventHandler eventHandler, Iterable<Event> events) {
for (Event event : events) {
eventHandler.handle(event);
}
}
/**
* Reports a warning.
*/
public static Event warn(Location location, String message) {
return new Event(EventKind.WARNING, location, message);
}
/**
* Reports an error.
*/
public static Event error(Location location, String message){
return new Event(EventKind.ERROR, location, message);
}
/**
* Reports atemporal statements about the build, i.e. they're true for the duration of execution.
*/
public static Event info(Location location, String message) {
return new Event(EventKind.INFO, location, message);
}
/**
* Reports a temporal statement about the build.
*/
public static Event progress(Location location, String message) {
return new Event(EventKind.PROGRESS, location, message);
}
/**
* Reports a warning.
*/
public static Event warn(String message) {
return warn(null, message);
}
/**
* Reports an error.
*/
public static Event error(String message){
return error(null, message);
}
/**
* Reports atemporal statements about the build, i.e. they're true for the duration of execution.
*/
public static Event info(String message) {
return info(null, message);
}
/**
* Reports a temporal statement about the build.
*/
public static Event progress(String message) {
return progress(null, message);
}
}
|
