Package com.google.inject.spi
Class Message
- java.lang.Object
-
- com.google.inject.spi.Message
-
- All Implemented Interfaces:
Element
,Serializable
public final class Message extends Object implements Serializable, Element
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 usingaddError()
statements:try { bindPropertiesFromFile(); } catch (IOException e) { addError(e); }
- Author:
- crazybob@google.com (Bob Lee)
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> T
acceptVisitor(ElementVisitor<T> visitor)
Accepts an element visitor.void
applyTo(Binder binder)
Writes this module element to the given binder (optional operation).boolean
equals(Object o)
Throwable
getCause()
Returns the throwable that caused this message, ornull
if this message was not caused by a throwable.String
getMessage()
Gets the error message text.String
getSource()
Returns an arbitrary object containing information about the "place" where this element was configured.List<Object>
getSources()
int
hashCode()
String
toString()
-
-
-
Method Detail
-
getSource
public String 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.
-
getMessage
public String getMessage()
Gets the error message text.
-
acceptVisitor
public <T> T acceptVisitor(ElementVisitor<T> visitor)
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
public Throwable getCause()
Returns the throwable that caused this message, ornull
if this message was not caused by a throwable.- Since:
- 2.0
-
-