Package com.google.inject.spi
Class Message
java.lang.Object
com.google.inject.spi.Message
- All Implemented Interfaces:
Element
,Serializable
An error message and the context in which it occured. Messages are usually created internally by
Guice and its extensions. Messages can be created explicitly in a module using
addError()
statements:
try { bindPropertiesFromFile(); } catch (IOException e) { addError(e); }
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ErrorDetail
<?> private final ErrorId
private static final long
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Message
(ErrorId errorId, ErrorDetail<?> errorDetail) Message
(GuiceInternal internalOnly, ErrorId errorId, ErrorDetail<?> errorDetail) -
Method Summary
Modifier and TypeMethodDescription<T> T
acceptVisitor
(ElementVisitor<T> visitor) Accepts an element visitor.void
Writes this module element to the given binder (optional operation).boolean
getCause()
Returns the throwable that caused this message, ornull
if this message was not caused by a throwable.ErrorDetail
<?> Returns details about this error message.Gets the error message text.Returns an arbitrary object containing information about the "place" where this element was configured.int
hashCode()
toString()
withSource
(List<Object> newSources) Returns a copy of thisMessage
with its sources replaced.private Object
When serialized, we convert the error detail to aGenericErrorDetail
with string sources.
-
Field Details
-
errorId
-
errorDetail
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
Message
- Since:
- 5.0
-
Message
-
Message
- Since:
- 2.0
-
Message
- Since:
- 2.0
-
Message
- Since:
- 4.0
-
Message
-
Message
-
-
Method Details
-
getErrorDetail
Returns details about this error message.- Since:
- 5.0
-
getSource
Description copied from interface:Element
Returns an arbitrary object containing information about the "place" where this element was configured. Used by Guice in the production of descriptive error messages.Tools might specially handle types they know about;
StackTraceElement
is a good example. Tools should simply calltoString()
on the source object if the type is unfamiliar. -
getSources
- Since:
- 2.0
-
getMessage
Gets the error message text. -
acceptVisitor
Description copied from interface:Element
Accepts an element visitor. Invokes the visitor method specific to this element's type.- Specified by:
acceptVisitor
in interfaceElement
- Parameters:
visitor
- to call back on- Since:
- 2.0
-
getCause
Returns the throwable that caused this message, ornull
if this message was not caused by a throwable.- Since:
- 2.0
-
toString
-
hashCode
public int hashCode() -
equals
-
applyTo
Description copied from interface:Element
Writes this module element to the given binder (optional operation). -
withSource
Returns a copy of thisMessage
with its sources replaced.- Since:
- 5.0
-
writeReplace
When serialized, we convert the error detail to aGenericErrorDetail
with string sources. This hurts our formatting, but it guarantees that the receiving end will be able to read the message.- Throws:
ObjectStreamException
-