Annotation Type OptionGroup


  • @Retention(RUNTIME)
    @Target(FIELD)
    public @interface OptionGroup
    Indicates which @Option-annotated fields are part of an option group — a related set of user-visible features. Option groups are documented in Options.

    Write OptionGroup on the first field in every group. Every @Option-annotated field must be part of a group if any of them are.

    @OptionGroup must appear after a field's Javadoc comment, if any. A Javadoc comment between @OptionGroup and the field is ignored. For example, you must write

      /** comment for first option*/
     @OptionGroup("the group")
     @Option("the first option")
      public static int first_option = blah;
    instead of
     @OptionGroup("the group")
    
      /** comment for first option*/
     @Option("the first option")
      public static int first_option = blah;
    See Also:
    Options, Option, Unpublicized, OptionsDoclet
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      Name of this option group.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean unpublicized
      Whether this option group is unpublicized.
    • Element Detail

      • value

        java.lang.String value
        Name of this option group. Must be unique across all objects that are passed to the Options constructor.
        Returns:
        the name of this option group
      • unpublicized

        boolean unpublicized
        Whether this option group is unpublicized.
        Returns:
        true if this option group is unpublicized, false if it is publicized
        Default:
        false