Module org.junit.platform.testkit
Package org.junit.platform.testkit.engine

Class TerminationInfo

java.lang.Object
org.junit.platform.testkit.engine.TerminationInfo
@API(status=MAINTAINED, since="1.7") public class TerminationInfo extends Object
TerminationInfo is a union type that allows propagation of terminated container/test state, supporting either the reason if the container/test was skipped or the TestExecutionResult if the container/test was executed.
Since:
1.4
See Also:
Execution.getTerminationInfo()

  • Method Details

    • skipped

      public static TerminationInfo skipped​(String reason)
      Create a skipped TerminationInfo instance for the supplied reason.
      Parameters:
      reason - the reason the execution was skipped; may be null
      Returns:
      the created TerminationInfo; never null
      See Also:
      executed(TestExecutionResult)

    • executed

      public static TerminationInfo executed​(TestExecutionResult testExecutionResult)
      Create an executed TerminationInfo instance for the supplied TestExecutionResult.
      Parameters:
      testExecutionResult - the result of the execution; never null
      Returns:
      the created TerminationInfo; never null
      See Also:
      skipped(String)

    • skipped

      public boolean skipped()
      Determine if this TerminationInfo represents a skipped execution.
      Returns:
      true if this this TerminationInfo represents a skipped execution

    • notSkipped

      public boolean notSkipped()
      Determine if this TerminationInfo does not represent a skipped execution.
      Returns:
      true if this this TerminationInfo does not represent a skipped execution

    • executed

      public boolean executed()
      Determine if this TerminationInfo represents a completed execution.
      Returns:
      true if this this TerminationInfo represents a completed execution

    • getSkipReason

      public String getSkipReason() throws UnsupportedOperationException
      Get the reason the execution was skipped.
      Returns:
      the reason the execution was skipped
      Throws:
      UnsupportedOperationException - if this TerminationInfo does not represent a skipped execution

    • getExecutionResult

      public TestExecutionResult getExecutionResult() throws UnsupportedOperationException
      Get the TestExecutionResult for the completed execution.
      Returns:
      the result of the completed execution
      Throws:
      UnsupportedOperationException - if this TerminationInfo does not represent a completed execution

    • toString

      public String toString()
      Overrides:
      toString in class Object