Class ResolutionException

  • All Implemented Interfaces:
    java.io.Serializable

    public class ResolutionException
    extends java.lang.Exception
    Indicates failure to resolve a set of requirements.

    If a resolution failure is caused by a missing mandatory dependency a resolver may include any requirements it has considered in the resolution exception. Clients may access this set of dependencies via the getUnresolvedRequirements() method.

    Resolver implementations may extend this class to provide extra state information about the reason for the resolution failure.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      ResolutionException​(java.lang.String message)
      Create a ResolutionException with the specified message.
      ResolutionException​(java.lang.String message, java.lang.Throwable cause, java.util.Collection<Requirement> unresolvedRequirements)
      Create a ResolutionException with the specified message, cause and unresolved requirements.
      ResolutionException​(java.lang.Throwable cause)
      Create a ResolutionException with the specified cause.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Collection<Requirement> getUnresolvedRequirements()
      Return the unresolved requirements, if any, for this exception.
      • 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

      • ResolutionException

        public ResolutionException​(java.lang.String message,
                                   java.lang.Throwable cause,
                                   java.util.Collection<Requirement> unresolvedRequirements)
        Create a ResolutionException with the specified message, cause and unresolved requirements.
        Parameters:
        message - The message.
        cause - The cause of this exception.
        unresolvedRequirements - The unresolved mandatory requirements from mandatory resources or null if no unresolved requirements information is provided.
      • ResolutionException

        public ResolutionException​(java.lang.String message)
        Create a ResolutionException with the specified message.
        Parameters:
        message - The message.
      • ResolutionException

        public ResolutionException​(java.lang.Throwable cause)
        Create a ResolutionException with the specified cause.
        Parameters:
        cause - The cause of this exception.
    • Method Detail

      • getUnresolvedRequirements

        public java.util.Collection<Requirement> getUnresolvedRequirements()
        Return the unresolved requirements, if any, for this exception.

        The unresolved requirements are provided for informational purposes and the specific set of unresolved requirements that are provided after a resolve failure is not defined.

        Returns:
        A collection of the unresolved requirements for this exception. The returned collection may be empty if no unresolved requirements information is available.