Package org.junit.platform.engine

Class FilterResult

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean excluded​()  
      static FilterResult excluded​(java.lang.String reason)
      Factory for creating excluded results.
      java.util.Optional<java.lang.String> getReason​()
      Get the reason why the filtered object should be included or excluded, if available.
      boolean included​()  
      static FilterResult included​(java.lang.String reason)
      Factory for creating included results.
      static FilterResult includedIf​(boolean included)
      Factory for creating filter results based on the condition given.
      static FilterResult includedIf​(boolean included, java.util.function.Supplier<java.lang.String> inclusionReasonSupplier, java.util.function.Supplier<java.lang.String> exclusionReasonSupplier)
      Factory for creating filter results based on the condition given.
      java.lang.String toString​()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • included

        public static FilterResult included​(java.lang.String reason)
        Factory for creating included results.
        Parameters:
        reason - the reason why the filtered object was included
        Returns:
        an included FilterResult with the given reason

      • excluded

        public static FilterResult excluded​(java.lang.String reason)
        Factory for creating excluded results.
        Parameters:
        reason - the reason why the filtered object was excluded
        Returns:
        an excluded FilterResult with the given reason

      • includedIf

        public static FilterResult includedIf​(boolean included)
        Factory for creating filter results based on the condition given.
        Parameters:
        included - whether or not the filtered object should be included
        Returns:
        a valid FilterResult for the given condition

      • includedIf

        public static FilterResult includedIf​(boolean included,
                                      java.util.function.Supplier<java.lang.String> inclusionReasonSupplier,
                                      java.util.function.Supplier<java.lang.String> exclusionReasonSupplier)
        Factory for creating filter results based on the condition given.
        Parameters:
        included - whether or not the filtered object should be included
        inclusionReasonSupplier - supplier for the reason in case of inclusion
        exclusionReasonSupplier - supplier for the reason in case of exclusion
        Returns:
        a valid FilterResult for the given condition

      • included

        public boolean included​()
        Returns:
        true if the filtered object should be included

      • excluded

        public boolean excluded​()
        Returns:
        true if the filtered object should be excluded

      • getReason

        public java.util.Optional<java.lang.String> getReason​()
        Get the reason why the filtered object should be included or excluded, if available.

      • toString

        public java.lang.String toString​()
        Overrides:
        toString in class java.lang.Object