Package net.neoforged.testframework.annotation

Annotation Interface TestHolder

@Retention(RUNTIME) @Target({TYPE,METHOD}) public @interface TestHolder
Annotation used by AbstractTest in order to collect information about a test.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    description
    This usually contains instructions on how to use the test.
    boolean
    enabledByDefault
    Returns if this test is enabled by default.
    String[]
    groups
    Returns the groups the test is in.
    net.neoforged.api.distmarker.Dist[]
    side
    Returns the sides this test should be registered on.
    String
    title
    Returns the human-readable title of the test.
    String
    value
    Returns the test's ID.

  • Element Details

    • value

      String value
      Returns the test's ID.
      Returns:
      the test's ID
      Default:
      "compute"

    • groups

      String[] groups
      Returns the groups the test is in.
      Note: if empty, it defaults to ungrouped.
      Returns:
      the groups the test is in
      See Also:
      Default:
      {}

    • title

      String title
      Returns the human-readable title of the test.
      Returns:
      the human-readable title of the test
      Default:
      ""

    • description

      String[] description
      This usually contains instructions on how to use the test. Returns the human-readable description of the test.
      Default:
      {}

    • enabledByDefault

      boolean enabledByDefault
      Returns if this test is enabled by default.
      Returns:
      if this test is enabled by default
      Default:
      false

    • side

      net.neoforged.api.distmarker.Dist[] side
      Returns the sides this test should be registered on.
      Returns:
      the sides this test should be registered on
      Default:
      {CLIENT, DEDICATED_SERVER}