@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface OptionMetadata
Modifier and Type | Required Element and Description |
---|---|
java.lang.String |
description
Description of this parameter.
|
java.lang.String |
displayName
The nice GUI displayable name for this parameter
|
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
category
Optional category for the parameter.
|
boolean |
commandLineParamIsFlag
True if the command line version of this parameter is a flag (i.e.
|
java.lang.String |
commandLineParamName
The name of the command line version of this parameter (without leading -).
|
java.lang.String |
commandLineParamSynopsis
The synopsis to display on in the command line help for this parameter
(e.g.
|
int |
displayOrder
The order (low to high), relative to other parameters, that this property
should be displayed in the GUI and, if applicable, on the command line help
|
public abstract java.lang.String displayName
public abstract java.lang.String description
public abstract java.lang.String category
public abstract int displayOrder
public abstract java.lang.String commandLineParamName
public abstract boolean commandLineParamIsFlag
public abstract java.lang.String commandLineParamSynopsis