Module org.praxislive.code
Package org.praxislive.code.userapi

Annotation Interface FN.Watch

Enclosing class:
FN
@Retention(RUNTIME) @Target(METHOD) public static @interface FN.Watch
Annotate a method as a FN.Watch function.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    mime
    The mime type of the returned data.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    relatedPort
    Optional name of a port on the component to relate the watch data to.
    int
    weight
    Relative weight compared to other @FN elements.

  • Element Details

    • mime

      String mime
      The mime type of the returned data. Will be included in the Watch info.
      Returns:
      data mime type

    • relatedPort

      String relatedPort
      Optional name of a port on the component to relate the watch data to.
      Returns:
      related port ID
      Default:
      ""

    • weight

      int weight
      Relative weight compared to other @FN elements. Functions will be sorted by weight, and then alphabetically. Higher weight elements will sort after lower weight elements.
      Returns:
      weight
      Default:
      0