Package org.camunda.community.bpmndt.model

Interface TestCases

public interface TestCases
Test cases of a BPMN model.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<TestCase>
    get()
    Gets all test cases of all processes that are defined in the BPMN model.
    List<TestCase>
    get(String processId)
    Gets the test cases of the process with the given ID.
    io.camunda.zeebe.model.bpmn.BpmnModelInstance
    getModelInstance()
    Returns the underlying BPMN model instance.
    Set<String>
    getProcessIds()
    Gets the IDs of all processes that are defined in the BPMN model.
    boolean
    isEmpty()
    Determines if the BPMN model does not define test cases.
    boolean
    isPlatform8()
    Determines if the BPMN model is a Camunda Platform 8 model.
    static TestCases
    of(io.camunda.zeebe.model.bpmn.BpmnModelInstance modelInstance)
    Gets the test cases of the given BPMN model instance.
    static TestCases
    of(InputStream stream)
    Reads test cases from the given input stream.
    static TestCases
    of(Path bpmnFile)
    Reads test cases from the BPMN file with the given path.

  • Method Details

    • of

      static TestCases of(InputStream stream)
      Reads test cases from the given input stream. A runtime exception is thrown, when the BPMN model could not be parsed.
      Parameters:
      stream - A stream to read from.
      Returns:
      The test cases.

    • of

      static TestCases of(io.camunda.zeebe.model.bpmn.BpmnModelInstance modelInstance)
      Gets the test cases of the given BPMN model instance.
      Parameters:
      modelInstance - A model instance with or without "bpmndt:testCases" extension elements.
      Returns:
      The test cases.

    • of

      static TestCases of(Path bpmnFile)
      Reads test cases from the BPMN file with the given path. A runtime exception is thrown, when the file could not be found or read or the BPMN model could not be parsed.
      Parameters:
      bpmnFile - A readable BPMN file.
      Returns:
      The test cases.

    • get

      List<TestCase> get()
      Gets all test cases of all processes that are defined in the BPMN model.
      Returns:
      A list, containing all test cases.

    • get

      List<TestCase> get(String processId)
      Gets the test cases of the process with the given ID.
      Parameters:
      processId - A specific process ID.
      Returns:
      The test cases of the process or an empty list, if the process has no test cases or does not exist.

    • getModelInstance

      io.camunda.zeebe.model.bpmn.BpmnModelInstance getModelInstance()
      Returns the underlying BPMN model instance.
      Returns:
      The BPMN model instance.

    • getProcessIds

      Set<String> getProcessIds()
      Gets the IDs of all processes that are defined in the BPMN model.
      Returns:
      A set, containing all process IDs.

    • isEmpty

      boolean isEmpty()
      Determines if the BPMN model does not define test cases.
      Returns:
      true, if no test cases are defined. Otherwise false.

    • isPlatform8

      boolean isPlatform8()
      Determines if the BPMN model is a Camunda Platform 8 model.
      Returns:
      true, if the model is designed for Camunda Platform 8. Otherwise false.