Package org.testng

Class SkipException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    TimeBombSkipException

    public class SkipException
    extends java.lang.RuntimeException
    The root exception for special skip handling. In case a @Test or @Configuration throws this exception the method will be considered a skip or a failure according to the return of isSkip(). Users may provide extensions to this mechanism by extending this class.
    Since:
    5.6
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      SkipException​(java.lang.String skipMessage)  
      SkipException​(java.lang.String skipMessage, java.lang.Throwable cause)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isSkip()
      Flag if the current exception marks a skipped method (true) or a failure ( false).
      protected void reduceStackTrace()
      Subclasses may use this method to reduce the printed stack trace.
      protected void restoreStackTrace()
      Restores the original exception stack trace after a previous call to reduceStackTrace().
      • 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

      • SkipException

        public SkipException​(java.lang.String skipMessage)
      • SkipException

        public SkipException​(java.lang.String skipMessage,
                             java.lang.Throwable cause)
    • Method Detail

      • isSkip

        public boolean isSkip()
        Flag if the current exception marks a skipped method (true) or a failure ( false). By default Subclasses should override this method in order to provide smarter behavior.
        Returns:
        true if the method should be considered a skip, false if the method should be considered failed. If not overwritten it returns true
      • reduceStackTrace

        protected void reduceStackTrace()
        Subclasses may use this method to reduce the printed stack trace. This method keeps only the last frame. Important: after calling this method the preserved internally and can be restored called restoreStackTrace().
      • restoreStackTrace

        protected void restoreStackTrace()
        Restores the original exception stack trace after a previous call to reduceStackTrace().