Package nzilbb.util

Annotation Type Switch

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String value
      'Usage' description of the switch.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean compulsory
      Whether or not the switch is compulsory.
      String label
      A short label for the switch.
      boolean persistent
      Whether or not the setting is persistent, and set during installation (true) or transitory, and specified for each invocation (false).
    • Element Detail

      • value

        String value
        'Usage' description of the switch.
        Returns:
        'Usage' description of the switch.
      • compulsory

        boolean compulsory
        Whether or not the switch is compulsory.
        Returns:
        true if the switch is compulsory, false otherwise.
        Default:
        false
      • persistent

        boolean persistent
        Whether or not the setting is persistent, and set during installation (true) or transitory, and specified for each invocation (false).
        Returns:
        true if the setting is persistent, false otherwise.
        Default:
        false
      • label

        String label
        A short label for the switch.
        Returns:
        A short label for the switch.
        Default:
        ""