plume

Annotation Type Option

Deprecated.

Use org.plumelib.options.Option

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

Indicates that the annotated field is set via command-line option. Takes a single string argument that describes the option. The string is in the format '[-c] [<type>] description':

• '-c' is an optional single-character short name for the option.
• '<type>' is an optional description of the option type, to be displayed instead of its Java type (e.g., '<filename>' if the variable's type is String). The less-than and greater-than symbols are required.
• 'description' is a short (one-line) description of the option suitable for a usage message. By convention, it starts with a capital letter but does not end with a period. The field's Javadoc comment should contain a longer description appropriate for a manual or manpage. The Javadoc comment often repeats something similar to the @Option description.

The command-line options are processed by the Options class. For example usage, see the documentation for Options.

See Also:

Options, OptionGroup, Unpublicized, OptionsDoclet

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value Deprecated. String that describes the option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	aliases Deprecated. Aliases for this option.
boolean	noDocDefault Deprecated. Whether not to hide default values.

Element Detail

value

public abstract java.lang.String value

Deprecated.

String that describes the option.

Returns:

a string that describes this option

See Also:

Option

aliases

public abstract java.lang.String[] aliases

Deprecated.

Aliases for this option. For information about the use of this field, see the section on Option aliases in Options. If there is only a single, one-character alias, it can be put at the beginning of the value field without the need for an aliases field.

Returns:

aliases for this option

Default:

{}

noDocDefault

public abstract boolean noDocDefault

Deprecated.

Whether not to hide default values. For information about this parameter, see the section on hiding default values in OptionsDoclet.

Returns:

whether not to hide default values

Default:

false