Top Description Fields Constructors Methods
com.google.inject.spi

public final Class Message

extends Object
implements Serializable, Element
Class Inheritance
All Implemented Interfaces
com.google.inject.spi.Element, java.io.Serializable
Static Imports
com.google.common.base.Preconditions.checkNotNull
An error message and the context in which it occurred. 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);
    }
Author
[email protected] (Bob Lee)

Field Summary

Modifier and TypeField and Description
private final ErrorDetail<?>
errorDetail

private final ErrorId
errorId

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Message(GuiceInternal internalOnly, ErrorId errorId, ErrorDetail<?> errorDetail)

private
Message(ErrorId errorId, ErrorDetail<?> errorDetail)

public
Message(ErrorId errorId, List<Object> sources, String message, Throwable cause)

public
Message(List<Object> sources, String message, Throwable cause)

public
Message(String message, Throwable cause)

public
Message(Object source, String message)

public
Message(String message)

Method Summary

Modifier and TypeMethod and Description
public <T> T
acceptVisitor(ElementVisitor<T>
to call back on
visitor)

Implements com.google.inject.spi.Element.acceptVisitor.

Accepts an element visitor.
public void
applyTo(Binder
to apply configuration element to
binder)

Implements com.google.inject.spi.Element.applyTo.

Writes this module element to the given binder (optional operation).
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public Throwable
getCause()

Returns the throwable that caused this message, or null if this message was not caused by a throwable.

public ErrorDetail<?>
getErrorDetail()

Returns details about this error message.

public String
getMessage()

Gets the error message text.

public String
getSource()

Implements com.google.inject.spi.Element.getSource.

Returns an arbitrary object containing information about the "place" where this element was configured.
public List<Object>
getSources()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Message
withSource(List<Object> newSources)

Returns a copy of this Message with its sources replaced.

private Object
writeReplace()

When serialized, we convert the error detail to a GenericErrorDetail with string sources.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

errorDetailback to summary
private final ErrorDetail<?> errorDetail
errorIdback to summary
private final ErrorId errorId
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Messageback to summary
public Message(GuiceInternal internalOnly, ErrorId errorId, ErrorDetail<?> errorDetail)
Since
5.0
Messageback to summary
private Message(ErrorId errorId, ErrorDetail<?> errorDetail)
Messageback to summary
public Message(ErrorId errorId, List<Object> sources, String message, Throwable cause)
Since
2.0
Messageback to summary
public Message(List<Object> sources, String message, Throwable cause)
Since
2.0
Messageback to summary
public Message(String message, Throwable cause)
Since
4.0
Messageback to summary
public Message(Object source, String message)
Messageback to summary
public Message(String message)

Method Detail

acceptVisitorback to summary
public <T> T acceptVisitor(ElementVisitor<T> visitor)

Implements com.google.inject.spi.Element.acceptVisitor.

Doc from com.google.inject.spi.Element.acceptVisitor.

Accepts an element visitor. Invokes the visitor method specific to this element's type.

Parameters
visitor:ElementVisitor<T>

to call back on

Annotations
@Override
Since
2.0
applyToback to summary
public void applyTo(Binder binder)

Implements com.google.inject.spi.Element.applyTo.

Doc from com.google.inject.spi.Element.applyTo.

Writes this module element to the given binder (optional operation).

Parameters
binder:Binder

to apply configuration element to

Annotations
@Override
Since
2.0
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getCauseback to summary
public Throwable getCause()

Returns the throwable that caused this message, or null if this message was not caused by a throwable.

Since
2.0
getErrorDetailback to summary
public ErrorDetail<?> getErrorDetail()

Returns details about this error message.

Since
5.0
getMessageback to summary
public String getMessage()

Gets the error message text.

getSourceback to summary
public String getSource()

Implements com.google.inject.spi.Element.getSource.

Doc from com.google.inject.spi.Element.getSource.

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 call toString() on the source object if the type is unfamiliar.

Annotations
@Override
getSourcesback to summary
public List<Object> getSources()
Since
2.0
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
withSourceback to summary
public Message withSource(List<Object> newSources)

Returns a copy of this Message with its sources replaced.

Since
5.0
writeReplaceback to summary
private Object writeReplace() throws ObjectStreamException

When serialized, we convert the error detail to a GenericErrorDetail with string sources. This hurts our formatting, but it guarantees that the receiving end will be able to read the message.