Class ReferenceResolverException

  • All Implemented Interfaces:
    java.io.Serializable

    @API(type=EXTENDABLE,
         src=PUBLIC)
    public class ReferenceResolverException
    extends java.lang.RuntimeException
    Exception thrown if the reference resolver could not resolve a target.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ReferenceResolverException​(java.lang.String errorMessage, boolean showInResultsPanel, boolean reportAsError)
      Constructor.
      ReferenceResolverException​(java.lang.String shortErrorMessage, java.lang.String originalErrorMessage, boolean showInResultsPanel, boolean reportAsError)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ReferenceErrorResolver getErrorResolver()
      Gets a possible solution for the user.
      java.lang.String getShortMessage()
      Obtain the exception short message.
      boolean isReportAsError()
      Check if the exception should be reported as an error.
      boolean isShowInResultsPanel()
      Check if should also show the message in a results panel.
      void setErrorResolver​(ReferenceErrorResolver errorResolver)
      Sets a possible solution for the user.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ReferenceResolverException

        public ReferenceResolverException​(java.lang.String errorMessage,
                                          boolean showInResultsPanel,
                                          boolean reportAsError)
        Constructor.
        Parameters:
        errorMessage - The error message.
        showInResultsPanel - true to also show the message in a results panel.
        reportAsError - true to report as error, false to report as warning.
      • ReferenceResolverException

        public ReferenceResolverException​(java.lang.String shortErrorMessage,
                                          java.lang.String originalErrorMessage,
                                          boolean showInResultsPanel,
                                          boolean reportAsError)
        Constructor.
        Parameters:
        shortErrorMessage - The short error message. Sometimes the message which will be presented first time to the user is shorter than the original message.
        originalErrorMessage - The exception original message.
        showInResultsPanel - true to also show the message in a results panel.
        reportAsError - true to report as error, false to report as warning.
    • Method Detail

      • isShowInResultsPanel

        public boolean isShowInResultsPanel()
        Check if should also show the message in a results panel.
        Returns:
        Returns true to also show the message in a results panel.
      • isReportAsError

        public boolean isReportAsError()
        Check if the exception should be reported as an error.
        Returns:
        Returns true to report as error, false to report as warning.
      • setErrorResolver

        public void setErrorResolver​(ReferenceErrorResolver errorResolver)
        Sets a possible solution for the user.
        Parameters:
        errorResolver - The errorResolver to set.
      • getErrorResolver

        public ReferenceErrorResolver getErrorResolver()
        Gets a possible solution for the user.
        Returns:
        Returns a possible solution for the user.
      • getShortMessage

        public java.lang.String getShortMessage()
        Obtain the exception short message.
        Returns:
        Returns the short message.