Top Description Methods

com.beust.jcommander

public @Interface Parameters

Annotations

extends Annotation

@Retention:RUNTIME
@Target:TYPE
@Inherited

Imports

java.lang.annotation.Inherited, .Retention, .Target

An annotation used to specify settings for parameter parsing.

Author: cbeust

Method Summary

Modifier and Type	Method and Description
public String	commandDescription() If the annotated class was added to `JCommander` as a command with `JCommander#addCommand`, then this string will be displayed in the description when `JCommander#usage` is invoked.
public String	Returns: the key used to find the command description in the resource bundle. commandDescriptionKey()
public String[]	commandNames() An array of allowed command names.
public boolean	hidden() If true, this command won't appear in the usage().
public String	resourceBundle() The name of the resource bundle to use for this class.
public String	separators() The character(s) that separate options.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

commandDescription	back to summary
public String commandDescription() If the annotated class was added to `JCommander` as a command with `JCommander#addCommand`, then this string will be displayed in the description when `JCommander#usage` is invoked.

commandDescriptionKey	back to summary
public String commandDescriptionKey() Returns:String the key used to find the command description in the resource bundle.

commandNames	back to summary
public String[] commandNames() An array of allowed command names.

hidden	back to summary
public boolean hidden() If true, this command won't appear in the usage().

resourceBundle	back to summary
public String resourceBundle() The name of the resource bundle to use for this class.

separators	back to summary
public String separators() The character(s) that separate options.