Annotation Interface Internal

@Documented @Retention(RUNTIME) @Target(METHOD) public @interface Internal
Documents internal framework methods on ToolContext and other toolkits, capturing human-readable descriptions and thread-safety requirements for subthread execution.
Author:
anahata

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Concise description of what the internal method does.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    requiresCapturedToolContext
    Whether calling this method from a subthread (e.g.

  • Element Details

    • value

      String value
      Concise description of what the internal method does.
      Returns:
      The method description.

    • requiresCapturedToolContext

      boolean requiresCapturedToolContext
      Whether calling this method from a subthread (e.g. JavaFX thread, custom thread pool, or worker task) requires capturing the ToolContext first via getToolContext().
      Returns:
      true if a captured ToolContext is required outside the tool execution thread.
      Default:
      false