程序包 cn.taketoday.core.env

类 SimpleCommandLinePropertySource

java.lang.Object

cn.taketoday.core.env.PropertySource<T>

cn.taketoday.core.env.EnumerablePropertySource<T>

cn.taketoday.core.env.CommandLinePropertySource<CommandLineArgs>

cn.taketoday.core.env.SimpleCommandLinePropertySource

public class SimpleCommandLinePropertySource
extends CommandLinePropertySource<CommandLineArgs>

CommandLinePropertySource implementation backed by a simple String array.

Purpose

This CommandLinePropertySource implementation aims to provide the simplest possible approach to parsing command line arguments. As with all CommandLinePropertySource implementations, command line arguments are broken into two distinct groups: option arguments and non-option arguments, as described below (some sections copied from Javadoc for SimpleCommandLineArgsParser):

Working with option arguments

Option arguments must adhere to the exact syntax:

--optName[=optValue]

That is, options must be prefixed with "--" and may or may not specify a value. If a value is specified, the name and value must be separated without spaces by an equals sign ("="). The value may optionally be an empty string.

Valid examples of option arguments

 --foo
 --foo=
 --foo=""
 --foo=bar
 --foo="bar then baz"
 --foo=bar,baz,biz
 

Invalid examples of option arguments

 -foo
 --foo bar
 --foo = bar
 --foo=bar --foo=baz --foo=biz
 

Working with non-option arguments

Any and all arguments specified at the command line without the "--" option prefix will be considered as "non-option arguments" and made available through the CommandLineArgs.getNonOptionArgs() method.

Typical usage

 public static void main(String[] args) {
     PropertySource<?> ps = new SimpleCommandLinePropertySource(args);
     // ...
 }
 

See CommandLinePropertySource for complete general usage examples.

Beyond the basics

When more fully-featured command line parsing is necessary, consider using the provided JOptCommandLinePropertySource, or implement your own CommandLinePropertySource against the command line parsing library of your choice.

从以下版本开始:

4.0

作者:

Chris Beams, Harry Yang

另请参阅:

• CommandLinePropertySource
• JOptCommandLinePropertySource

嵌套类概要

从类继承的嵌套类/接口 cn.taketoday.core.env.PropertySource

PropertySource.ComparisonPropertySource, PropertySource.StubPropertySource

字段概要

从类继承的字段 cn.taketoday.core.env.CommandLinePropertySource

COMMAND_LINE_PROPERTY_SOURCE_NAME, DEFAULT_NON_OPTION_ARGS_PROPERTY_NAME

从类继承的字段 cn.taketoday.core.env.PropertySource

name, source

构造器概要

构造器

构造器	说明
SimpleCommandLinePropertySource(String... args)	Create a new SimpleCommandLinePropertySource having the default name and backed by the given String[] of command line arguments.
SimpleCommandLinePropertySource(String name, String[] args)	Create a new SimpleCommandLinePropertySource having the given name and backed by the given String[] of command line arguments.

方法概要

修饰符和类型	方法	说明
protected boolean	containsOption(String name)	Return whether the set of option arguments parsed from the command line contains an option with the given name.
protected List<String>	getNonOptionArgs()	Return the collection of non-option arguments parsed from the command line.
protected List<String>	getOptionValues(String name)	Return the collection of values associated with the command line option having the given name.
String[]	getPropertyNames()	Get the property names for the option arguments.

从类继承的方法 cn.taketoday.core.env.CommandLinePropertySource

containsProperty, getProperty, setNonOptionArgsPropertyName

从类继承的方法 cn.taketoday.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

SimpleCommandLinePropertySource

public SimpleCommandLinePropertySource(String... args)

Create a new SimpleCommandLinePropertySource having the default name and backed by the given String[] of command line arguments.

另请参阅:

• CommandLinePropertySource.COMMAND_LINE_PROPERTY_SOURCE_NAME
• CommandLinePropertySource(Object)

SimpleCommandLinePropertySource

public SimpleCommandLinePropertySource(String name,
 String[] args)

Create a new SimpleCommandLinePropertySource having the given name and backed by the given String[] of command line arguments.

方法详细资料

getPropertyNames

@NonNull
public String[] getPropertyNames()

Get the property names for the option arguments.

指定者:

getPropertyNames 在类中 EnumerablePropertySource<CommandLineArgs>

containsOption

protected boolean containsOption(String name)

从类复制的说明: CommandLinePropertySource

Return whether the set of option arguments parsed from the command line contains an option with the given name.

指定者:

containsOption 在类中 CommandLinePropertySource<CommandLineArgs>

getOptionValues

@Nullable
protected List<String> getOptionValues(String name)

从类复制的说明: CommandLinePropertySource

Return the collection of values associated with the command line option having the given name.

• if the option is present and has no argument (e.g.: "--foo"), return an empty collection ([])
• if the option is present and has a single value (e.g. "--foo=bar"), return a collection having one element (["bar"])
• if the option is present and the underlying command line parsing library supports multiple arguments (e.g. "--foo=bar --foo=baz"), return a collection having elements for each value (["bar", "baz"])
• if the option is not present, return null

指定者:

getOptionValues 在类中 CommandLinePropertySource<CommandLineArgs>

getNonOptionArgs

protected List<String> getNonOptionArgs()

从类复制的说明: CommandLinePropertySource

Return the collection of non-option arguments parsed from the command line. Never null.

指定者:

getNonOptionArgs 在类中 CommandLinePropertySource<CommandLineArgs>