Package org.apache.maven.enforcer.rule.api

Class EnforcerRuleException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    EnforcerRuleError
    public class EnforcerRuleException
extends java.lang.Exception
    An exception occurring during the execution of a rule.

    Enforcer plugin takes decision based on configuration and Enforcer Rule level whether build should pass or fail.

    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String longMessage
      The long message.
      private static long serialVersionUID
      serialVersionUID.
      protected java.lang.Object source
      The source.

    • Constructor Summary

      Constructors 
      Constructor Description
      EnforcerRuleException​(java.lang.Object source, java.lang.String shortMessage, java.lang.String longMessage)
      Deprecated.
      source and longMessage are not used
      EnforcerRuleException​(java.lang.String message)
      Construct a new EnforcerRuleException exception providing a message.
      EnforcerRuleException​(java.lang.String message, java.lang.Exception cause)
      Construct a new EnforcerRuleException exception wrapping an underlying Exception and providing a message.
      EnforcerRuleException​(java.lang.String message, java.lang.Throwable cause)
      Construct a new EnforcerRuleException exception wrapping an underlying Throwable and providing a message.
      EnforcerRuleException​(java.lang.Throwable cause)
      Construct a new EnforcerRuleException exception wrapping an underlying Throwable.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getLongMessage()
      Deprecated.
      not used
      java.lang.Object getSource()
      Deprecated.
      not used

      • 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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        serialVersionUID.
        See Also:
        Constant Field Values

      • source

        protected java.lang.Object source
        The source.

      • longMessage

        protected java.lang.String longMessage
        The long message.

    • Constructor Detail

      • EnforcerRuleException

        @Deprecated
public EnforcerRuleException​(java.lang.Object source,
                             java.lang.String shortMessage,
                             java.lang.String longMessage)
        Deprecated.
        source and longMessage are not used
        Construct a new EnforcerRuleException exception providing the source and a short and long message.
        Parameters:
        source - the source
        shortMessage - the short message
        longMessage - the long message

      • EnforcerRuleException

        public EnforcerRuleException​(java.lang.String message,
                             java.lang.Exception cause)
        Construct a new EnforcerRuleException exception wrapping an underlying Exception and providing a message.
        Parameters:
        message - the message
        cause - the cause

      • EnforcerRuleException

        public EnforcerRuleException​(java.lang.String message,
                             java.lang.Throwable cause)
        Construct a new EnforcerRuleException exception wrapping an underlying Throwable and providing a message.
        Parameters:
        message - the message
        cause - the cause

      • EnforcerRuleException

        public EnforcerRuleException​(java.lang.String message)
        Construct a new EnforcerRuleException exception providing a message.
        Parameters:
        message - the message

      • EnforcerRuleException

        public EnforcerRuleException​(java.lang.Throwable cause)
        Construct a new EnforcerRuleException exception wrapping an underlying Throwable.
        Parameters:
        cause - the cause

    • Method Detail

      • getLongMessage

        @Deprecated
public java.lang.String getLongMessage()
        Deprecated.
        not used
        Gets the long message.
        Returns:
        the long message

      • getSource

        @Deprecated
public java.lang.Object getSource()
        Deprecated.
        not used
        Gets the source.
        Returns:
        the source