Package org.elasticsearch.common.inject.spi

Class Message

org.elasticsearch.common.inject.spi.Message
All Implemented Interfaces:
Element
public final class Message extends implements Element
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);
     }

  • Constructor Summary

    Constructors
    Constructor
    Description
     source,  message)
     
     source,  cause)
     
     message)
     
    <> sources,  message,  cause)
     

  • Method Summary

    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
     o)
     
    getCause()
    Returns the throwable that caused this message, or null if this message was not caused by a throwable.
    getMessage()
    Gets the error message text.
    getSource()
    Returns an arbitrary object containing information about the "place" where this element was configured.
    <>
    getSources()
     
    int
    hashCode()
     
    toString()
     

    Methods inherited from class java.lang.

    , , , , , , ,

  • Constructor Details

    • Message

      public Message​(<> sources,  message,  cause)
      Since:
      2.0

    • Message

      public Message​( source,  message)

    • Message

      public Message​( source,  cause)

    • Message

      public Message​( message)

  • Method Details

    • getSource

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

      Specified by:
      getSource in interface Element

    • getSources

      public <> getSources()
      Since:
      2.0

    • getMessage

      public  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 interface Element
      Parameters:
      visitor - to call back on
      Since:
      2.0

    • getCause

      public  getCause()
      Returns the throwable that caused this message, or null if this message was not caused by a throwable.
      Since:
      2.0

    • toString

      public  toString()
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • applyTo

      public void applyTo​(Binder binder)
      Description copied from interface: Element
      Writes this module element to the given binder (optional operation).
      Specified by:
      applyTo in interface Element
      Parameters:
      binder - to apply configuration element to
      Since:
      2.0