Top Description Constructors Methods
org.springframework.core.env

pack-priv Class SimpleCommandLineArgsParser

extends Object
Class Inheritance

Parses a String[] of command line arguments in order to populate a CommandLineArgs object.

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.

Authors
Chris Beams, Sam Brannen
Since
3.1

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public CommandLineArgs
parse(String...
command line arguments, typically from a main() method
args
)

Parse the given String array based on the rules described above, returning a fully-populated CommandLineArgs object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SimpleCommandLineArgsParserback to summary
pack-priv SimpleCommandLineArgsParser()

Method Detail

parseback to summary
public CommandLineArgs parse(String... args)

Parse the given String array based on the rules described above, returning a fully-populated CommandLineArgs object.

Parameters
args:String[]

command line arguments, typically from a main() method