com.beust.jcommander
Annotation Type Parameters


@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Parameters

An annotation used to specify settings for parameter parsing.

Author:
cbeust

Optional Element Summary
 String commandDescription
          If the annotated class was added to JCommander as a command with JCommander.addCommand(java.lang.String, java.lang.Object), then this string will be displayed in the description when @{link JCommander#usage} is invoked.
 String commandDescriptionKey
           
 String[] commandNames
          An array of allowed command names.
 String optionPrefixes
          What characters an option starts with.
 String resourceBundle
          The name of the resource bundle to use for this class.
 String separators
          The character(s) that separate options.
 

resourceBundle

public abstract String resourceBundle
The name of the resource bundle to use for this class.

Default:
""

separators

public abstract String separators
The character(s) that separate options.

Default:
" "

optionPrefixes

public abstract String optionPrefixes
What characters an option starts with.

Default:
"-"

commandDescription

public abstract String commandDescription
If the annotated class was added to JCommander as a command with JCommander.addCommand(java.lang.String, java.lang.Object), then this string will be displayed in the description when @{link JCommander#usage} is invoked.

Default:
""

commandDescriptionKey

public abstract String commandDescriptionKey
Returns:
the key used to find the command description in the resource bundle.
Default:
""

commandNames

public abstract String[] commandNames
An array of allowed command names.

Default:
{}


Copyright © 2012. All Rights Reserved.