Package com.inductiveautomation.ignition.common.script.hints

Annotation Interface JythonThrows

@Retention(RUNTIME) @Target({METHOD,FIELD}) public @interface JythonThrows
Provides meta-information about exceptions that a function exposed to Jython may throw.

Has no actual semantics to the rest of the system! This is purely an information annotation used by PropertiesFileDocProvider to generate documentation for the Designer's script editor.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
    Fully qualified names of any exceptions the function may throw that can't be added to its explicit throws clause.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    ignored
    Any exceptions that should be ignored when generating documentation for this function.

  • Element Details

    • value

      String[] value
      Fully qualified names of any exceptions the function may throw that can't be added to its explicit throws clause. These exceptions will be added to the documentation for the function. Descriptions for these exceptions should be added to the properties file using the $function.throws.$Exception key.

      For example, 

           @JythonThrows({"ValueError", "TypeError", "java.lang.IllegalArgumentException"})

    • ignored

      String[] ignored
      Any exceptions that should be ignored when generating documentation for this function.
      Default:
      {}