Top Description Methods
org.kohsuke.args4j

public @Interface Argument

extends Annotation
Known Direct Implementers
org.kohsuke.args4j.spi.ArgumentImpl
Annotations
@Retention:RUNTIME
@Target:FIELD, METHOD, PARAMETER
Imports
java.lang.annotation.Retention, .Target, org.kohsuke.args4j.spi.OptionHandler

Argument of the command line. This works mostly like Option except the following differences.
  1. Arguments have an index about their relative position on the command line.
Authors
Kohsuke Kawaguchi, Mark Sinke

Method Summary

Modifier and TypeMethod and Description
public Class<? extends OptionHandler<T>>
public boolean
public int
index()

Position of the argument.

public String
public boolean
public boolean
public String
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

handlerback to summary
public Class<? extends OptionHandler<T>> handler()

See Option#handler().

hiddenback to summary
public boolean hidden()

See Option#hidden().

indexback to summary
public int index()

Position of the argument.

If you define multiple single value properties to bind to arguments, they should have index=0, index=1, index=2, ... and so on.

Multi value properties bound to arguments must be always the last entry.

metaVarback to summary
public String metaVar()

See Option#metaVar().

multiValuedback to summary
public boolean multiValued()
requiredback to summary
public boolean required()

See Option#required().

usageback to summary
public String usage()

See Option#usage().