Package gda.jython

Annotation Interface GdaJythonBuiltin

@Retention(RUNTIME) @Target(METHOD) public @interface GdaJythonBuiltin
Annotation to be added to static methods to make them available as Jython builtins. When used with GdaBuiltin, annotated functions will be combined by name and converted to PyObjects. A docstring can be passed to the annotation and will be included in the generated help text. The signature of the functions are generated by reflection so does not need to be included.

If a function is overloaded and this annotation is applied to more than one, all docstring values will be concatenated so only one needs to be given. If individual functions need additional docs (when overloaded) an overload value can be given. This will be added for docs of a specific function.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    docstring
    Docstring for the annotated function.
    String
    overload
    Docstring specific to this version of an overloaded function

  • Element Details

    • docstring

      String docstring
      Docstring for the annotated function. If function is overloaded, docs are concatenated.
      Default:
      ""

    • overload

      String overload
      Docstring specific to this version of an overloaded function
      Default:
      ""