Package org.junit.platform.launcher

Class EngineFilter

  • All Implemented Interfaces:
    org.junit.platform.engine.Filter<org.junit.platform.engine.TestEngine>
    @API(status=STABLE,
     since="1.0")
public class EngineFilter
extends java.lang.Object
implements org.junit.platform.engine.Filter<org.junit.platform.engine.TestEngine>
    An EngineFilter is applied to all TestEngines before they are used.

    Warning: be cautious when registering multiple competing include EngineFilters or multiple competing exclude EngineFilters for the same discovery request since doing so will likely lead to undesirable results (i.e., zero engines being active).

    Since:
    1.0
    See Also:
    includeEngines(String...), excludeEngines(String...), LauncherDiscoveryRequest

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.junit.platform.engine.FilterResult apply​(org.junit.platform.engine.TestEngine testEngine)  
      static EngineFilter excludeEngines​(java.lang.String... engineIds)
      Create a new exclude EngineFilter based on the supplied engine IDs.
      static EngineFilter excludeEngines​(java.util.List<java.lang.String> engineIds)
      Create a new exclude EngineFilter based on the supplied engine IDs.
      static EngineFilter includeEngines​(java.lang.String... engineIds)
      Create a new include EngineFilter based on the supplied engine IDs.
      static EngineFilter includeEngines​(java.util.List<java.lang.String> engineIds)
      Create a new include EngineFilter based on the supplied engine IDs.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.junit.platform.engine.Filter

        toPredicate

    • Method Detail

      • includeEngines

        public static EngineFilter includeEngines​(java.lang.String... engineIds)
        Create a new include EngineFilter based on the supplied engine IDs.

        Only TestEngines with matching engine IDs will be included within the test discovery and execution.

        Parameters:
        engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank
        See Also:
        includeEngines(String...)

      • includeEngines

        public static EngineFilter includeEngines​(java.util.List<java.lang.String> engineIds)
        Create a new include EngineFilter based on the supplied engine IDs.

        Only TestEngines with matching engine IDs will be included within the test discovery and execution.

        Parameters:
        engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank
        See Also:
        includeEngines(String...)

      • excludeEngines

        public static EngineFilter excludeEngines​(java.lang.String... engineIds)
        Create a new exclude EngineFilter based on the supplied engine IDs.

        TestEngines with matching engine IDs will be excluded from test discovery and execution.

        Parameters:
        engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank
        See Also:
        excludeEngines(List)

      • excludeEngines

        public static EngineFilter excludeEngines​(java.util.List<java.lang.String> engineIds)
        Create a new exclude EngineFilter based on the supplied engine IDs.

        TestEngines with matching engine IDs will be excluded from test discovery and execution.

        Parameters:
        engineIds - the list of engine IDs to match against; never null or empty; individual IDs must also not be null or blank
        See Also:
        includeEngines(String...)

      • apply

        public org.junit.platform.engine.FilterResult apply​(org.junit.platform.engine.TestEngine testEngine)
        Specified by:
        apply in interface org.junit.platform.engine.Filter<org.junit.platform.engine.TestEngine>

      • toString

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