Package com.beust.jcommander
Class JCommander.Builder
- java.lang.Object
-
- com.beust.jcommander.JCommander.Builder
-
- Enclosing class:
- JCommander
public static class JCommander.Builder extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String[]argsprivate JCommanderjCommander
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JCommander.BuilderacceptUnknownOptions(boolean b)JCommander.BuilderaddCommand(java.lang.Object command)JCommander.BuilderaddCommand(java.lang.String name, java.lang.Object command, java.lang.String... aliases)JCommander.BuilderaddConverterFactory(IStringConverterFactory factory)Adds a factory to lookup string converters.JCommander.BuilderaddConverterInstanceFactory(IStringConverterInstanceFactory factory)JCommander.BuilderaddObject(java.lang.Object o)Adds the provided arg object to the set of objects that this commander will parse arguments into.JCommander.BuilderallowAbbreviatedOptions(boolean b)JCommander.BuilderallowParameterOverwriting(boolean b)JCommander.Builderargs(java.lang.String[] args)JCommander.BuilderatFileCharset(java.nio.charset.Charset charset)JCommanderbuild()JCommander.BuildercolumnSize(int columnSize)JCommander.Builderconsole(Console console)JCommander.BuilderdefaultProvider(IDefaultProvider provider)Define the default provider for this instance.JCommander.BuilderexpandAtSign(java.lang.Boolean expand)Disables expanding@file.JCommander.BuilderprogramName(java.lang.String name)Set the program name (used only in the usage).JCommander.BuilderresourceBundle(java.util.ResourceBundle bundle)Sets theResourceBundleto use for looking up descriptions.JCommander.BuilderusageFormatter(IUsageFormatter usageFormatter)JCommander.Builderverbose(int verbose)
-
-
-
Field Detail
-
jCommander
private JCommander jCommander
-
args
private java.lang.String[] args
-
-
Method Detail
-
addObject
public JCommander.Builder addObject(java.lang.Object o)
Adds the provided arg object to the set of objects that this commander will parse arguments into.- Parameters:
o- The arg object expected to containParameterannotations. Ifobjectis an array or isIterable, the child objects will be added instead.
-
resourceBundle
public JCommander.Builder resourceBundle(java.util.ResourceBundle bundle)
Sets theResourceBundleto use for looking up descriptions. Set this tonullto use description text directly.
-
args
public JCommander.Builder args(java.lang.String[] args)
-
console
public JCommander.Builder console(Console console)
-
expandAtSign
public JCommander.Builder expandAtSign(java.lang.Boolean expand)
Disables expanding@file. JCommander supports the@filesyntax, which allows you to put all your options into a file and pass this file as parameter @param expandAtSign whether to expand@file.
-
programName
public JCommander.Builder programName(java.lang.String name)
Set the program name (used only in the usage).
-
columnSize
public JCommander.Builder columnSize(int columnSize)
-
defaultProvider
public JCommander.Builder defaultProvider(IDefaultProvider provider)
Define the default provider for this instance.
-
addConverterFactory
public JCommander.Builder addConverterFactory(IStringConverterFactory factory)
Adds a factory to lookup string converters. The added factory is used prior to previously added factories.- Parameters:
factory- the factory determining string converters
-
verbose
public JCommander.Builder verbose(int verbose)
-
allowAbbreviatedOptions
public JCommander.Builder allowAbbreviatedOptions(boolean b)
-
acceptUnknownOptions
public JCommander.Builder acceptUnknownOptions(boolean b)
-
allowParameterOverwriting
public JCommander.Builder allowParameterOverwriting(boolean b)
-
atFileCharset
public JCommander.Builder atFileCharset(java.nio.charset.Charset charset)
-
addConverterInstanceFactory
public JCommander.Builder addConverterInstanceFactory(IStringConverterInstanceFactory factory)
-
addCommand
public JCommander.Builder addCommand(java.lang.Object command)
-
addCommand
public JCommander.Builder addCommand(java.lang.String name, java.lang.Object command, java.lang.String... aliases)
-
usageFormatter
public JCommander.Builder usageFormatter(IUsageFormatter usageFormatter)
-
build
public JCommander build()
-
-