plume

Annotation Type OptionGroup

Deprecated.

Use org.plumelib.options.OptionGroup

@Deprecated
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface OptionGroup

Used in conjunction with the @Option annotation to indicate that the following @Option-annotated fields (including the one the @OptionGroup annotation is applied to) belong to the same option group. Option groups are documented in Options.

Note that @OptionGroup must be applied to a field and must appear after that 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 and Description
java.lang.String	value Deprecated. Name of this option group.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	unpublicized Deprecated. Whether this option group is unpublicized.

Element Detail

value

public abstract java.lang.String value

Deprecated.

Name of this option group.

Returns:

the name of this option group

unpublicized

public abstract boolean unpublicized

Deprecated.

Whether this option group is unpublicized.

Returns:

true if this option group is unpublicized, false if it is publicized

Default:

false