blob: edefa14e07f6a1e36887cbb9208265ea96ae6a68 (
plain) (
blame)
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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.messagebus;
/**
* This class implements the pair (code, message) that is used in Reply to hold errors.
*
* @author Simon Thoresen Hult
*/
public final class Error {
private final int code;
private final String message;
private final String service;
/**
* This is the constructor used by anyone adding an error to a message. One does not manually need to set the
* service name of an error, so ignore the other constructor when creating your own error instance.
*
* @param code The numerical code of this error.
* @param message The description of this error.
*/
public Error(int code, String message) {
this.code = code;
this.message = message;
service = null;
}
/**
* This constructor is used by the network layer to properly tag deserialized errors with the hostname of whatever
* service produced the error. This constructor should NOT be used when manually creating errors.
*
* @param code The numerical code of this error.
* @param message The description of this error.
* @param service The service name of this error.
*/
public Error(int code, String message, String service) {
this.code = code;
this.message = message;
this.service = service;
}
/**
* Return the numerical code of this error.
*
* @return The numerical code.
*/
public int getCode() {
return code;
}
/**
* Return the description of this error.
*
* @return The description.
*/
public String getMessage() {
return message;
}
/**
* Returns the name of the service on which this error occured.
*
* @return The service name.
*/
public String getService() {
return service;
}
/**
* Returns whether or not this error is fatal, i.e. getCode() >= ErrorCode.FATAL_ERROR.
*
* @return True, if this error is fatal.
*/
public boolean isFatal() {
return code >= ErrorCode.FATAL_ERROR;
}
@Override
public String toString() {
String name = ErrorCode.getName(code);
return "[" +
name + " @ " +
(service != null ? service : "localhost") +
"]: " + message;
}
}
|