org.neo4j.helpers

Class Args

java.lang.Object

org.neo4j.helpers.Args

public class Args
extends Object

Parses a String[] argument from a main-method. It expects values to be either key/value pairs or just "orphan" values (w/o a key associated).

A key is defined with one or more dashes in the beginning, for example:

   '-path'
   '--path'
 

A key/value pair can be either one single String from the array where there's a '=' delimiter between the key and value, like so:

   '--path=/my/path/to/something'
 

...or consist of two (consecutive) strings from the array, like so:

   '-path' '/my/path/to/something'
 

Multiple values for an option is supported, however the only means of extracting all values is be using interpretOptions(String, Function, Function, Validator...), all other methods revolve around single value, i.e. will fail if there are multiple. Options can have metadata which can be extracted using interpretOptions(String, Function, Function, Validator...). Metadata looks like:

   --my-option:Metadata my-value
 

where Metadata would be the metadata of my-value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Args.ArgsParser
static class	Args.Option<T>

Constructor Summary

Constructors

Constructor and Description
Args(org.neo4j.function.Function<String,Args.Option<String>> optionParser, Map<String,String> source)
Args(Map<String,String> source)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	asArgs()
Map<String,String>	asMap()
String	get(String key)
String	get(String key, String defaultValue)
String	get(String key, String defaultValueIfNotFound, String defaultValueIfNoValue)
boolean	getBoolean(String key) Like calling getBoolean(String, Boolean) with false for default value.
Boolean	getBoolean(String key, Boolean defaultValueIfNotSpecified) Like calling getBoolean(String, Boolean, Boolean) with true for defaultValueIfNoValue, i.e.
Boolean	getBoolean(String key, Boolean defaultValueIfNotSpecified, Boolean defaultValueIfSpecifiedButNoValue) Parses a boolean argument.
long	getDuration(String key, long defaultValueInMillis)
<T extends Enum<T>> T	getEnum(Class<T> enumClass, String key, T defaultValue)
Number	getNumber(String key, Number defaultValue)
boolean	has(String key)
boolean	hasNonNull(String key)
<T> T	interpretOption(String key, org.neo4j.function.Function<String,T> defaultValue, org.neo4j.function.Function<String,T> converter, org.neo4j.kernel.impl.util.Validator<T>... validators)
<T> Collection<T>	interpretOptions(String key, org.neo4j.function.Function<String,T> defaultValue, org.neo4j.function.Function<String,T> converter, org.neo4j.kernel.impl.util.Validator<T>... validators) An option can be specified multiple times; this method will allow interpreting all values for the given key, returning a Collection.
<T> Collection<Args.Option<T>>	interpretOptionsWithMetadata(String key, org.neo4j.function.Function<String,T> defaultValue, org.neo4j.function.Function<String,T> converter, org.neo4j.kernel.impl.util.Validator<T>... validators) An option can be specified multiple times; this method will allow interpreting all values for the given key, returning a Collection.
<T> T	interpretOrphan(int index, org.neo4j.function.Function<String,T> defaultValue, org.neo4j.function.Function<String,T> converter, org.neo4j.kernel.impl.util.Validator<T>... validators)
static String	jarUsage(Class<?> main, String... params)
List<String>	orphans()
String[]	orphansAsArray()
static Args	parse(String... args)
String[]	source()
static String[]	splitLongLine(String description, int maxLength) Useful for printing usage where the description itself shouldn't have knowledge about the width of the window where it's printed.
String	toString()
static Args.ArgsParser	withFlags(String... flags)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Args

public Args(Map<String,String> source)

Args

public Args(org.neo4j.function.Function<String,Args.Option<String>> optionParser,
    Map<String,String> source)

Method Detail

withFlags

public static Args.ArgsParser withFlags(String... flags)

parse

public static Args parse(String... args)

source

public String[] source()

asMap

public Map<String,String> asMap()

has

public boolean has(String key)

hasNonNull

public boolean hasNonNull(String key)

get

public String get(String key)

get

public String get(String key,
         String defaultValue)

get

public String get(String key,
         String defaultValueIfNotFound,
         String defaultValueIfNoValue)

getNumber

public Number getNumber(String key,
               Number defaultValue)

getDuration

public long getDuration(String key,
               long defaultValueInMillis)

getBoolean

public boolean getBoolean(String key)

Like calling getBoolean(String, Boolean) with false for default value. This is the most common case, i.e. returns true if boolean argument was specified as:

• --myboolean
• --myboolean=true

Otherwise false.

Parameters:

key - argument key.

Returns:

true if argument was specified w/o value, or w/ value true, otherwise false.

getBoolean

public Boolean getBoolean(String key,
                 Boolean defaultValueIfNotSpecified)

Like calling getBoolean(String, Boolean, Boolean) with true for defaultValueIfNoValue, i.e. specifying --myarg will interpret it as true.

getBoolean

public Boolean getBoolean(String key,
                 Boolean defaultValueIfNotSpecified,
                 Boolean defaultValueIfSpecifiedButNoValue)

Parses a boolean argument. There are a couple of cases:

• The argument isn't specified. In this case the value of defaultValueIfNotSpecified will be returned.
• The argument is specified without value, for example

  --myboolean

  . In this case the value of defaultValueIfNotSpecified will be returned.
• The argument is specified with value, for example

  --myboolean=true

  . In this case the actual value will be returned.

Parameters:

key - argument key.

defaultValueIfNotSpecified - used if argument not specified.

defaultValueIfSpecifiedButNoValue - used if argument specified w/o value.

Returns:

argument boolean value depending on what was specified, see above.

getEnum

public <T extends Enum<T>> T getEnum(Class<T> enumClass,
                            String key,
                            T defaultValue)

orphans

public List<String> orphans()

orphansAsArray

public String[] orphansAsArray()

asArgs

public String[] asArgs()

toString

public String toString()

Overrides:

toString in class Object

jarUsage

public static String jarUsage(Class<?> main,
              String... params)

splitLongLine

public static String[] splitLongLine(String description,
                     int maxLength)

Useful for printing usage where the description itself shouldn't have knowledge about the width of the window where it's printed. Existing new-line characters in the text are honored.

Parameters:

description - text to split, if needed.

maxLength - line length to split at, actually closest previous white space.

Returns:

description split into multiple lines if need be.

interpretOption

@SafeVarargs
public final <T> T interpretOption(String key,
                                org.neo4j.function.Function<String,T> defaultValue,
                                org.neo4j.function.Function<String,T> converter,
                                org.neo4j.kernel.impl.util.Validator<T>... validators)

interpretOptions

@SafeVarargs
public final <T> Collection<T> interpretOptions(String key,
                                             org.neo4j.function.Function<String,T> defaultValue,
                                             org.neo4j.function.Function<String,T> converter,
                                             org.neo4j.kernel.impl.util.Validator<T>... validators)

An option can be specified multiple times; this method will allow interpreting all values for the given key, returning a Collection. This is the only means of extracting multiple values for any given option. All other methods revolve around zero or one value for an option.

Type Parameters:

T - The type of the option values

Parameters:

key - Key of the option

defaultValue - Default value value of the option

converter - Converter to use

validators - Validators to use

Returns:

The option values

interpretOptionsWithMetadata

@SafeVarargs
public final <T> Collection<Args.Option<T>> interpretOptionsWithMetadata(String key,
                                                                      org.neo4j.function.Function<String,T> defaultValue,
                                                                      org.neo4j.function.Function<String,T> converter,
                                                                      org.neo4j.kernel.impl.util.Validator<T>... validators)

An option can be specified multiple times; this method will allow interpreting all values for the given key, returning a Collection. This is the only means of extracting multiple values for any given option. All other methods revolve around zero or one value for an option. This is also the only means of extracting metadata about a options. Metadata can be supplied as part of the option key, like --my-option:Metadata "my value".

Type Parameters:

T - The type of the option values

Parameters:

key - Key of the option

defaultValue - Default value value of the option

converter - Converter to use

validators - Validators to use

Returns:

The option values

interpretOrphan

@SafeVarargs
public final <T> T interpretOrphan(int index,
                                org.neo4j.function.Function<String,T> defaultValue,
                                org.neo4j.function.Function<String,T> converter,
                                org.neo4j.kernel.impl.util.Validator<T>... validators)