org.neo4j.commandline.arguments

Interface NamedArgument

All Known Implementing Classes:

Database, MandatoryCanonicalPath, MandatoryNamedArg, OptionalBooleanArg, OptionalCanonicalPath, OptionalNamedArg, OptionalNamedArgWithMetadata

public interface NamedArgument

Method Summary

Modifier and Type	Method and Description
String	description() An explanation of the option in the options list.
String	exampleValue() Example value listed in usage between brackets like '--name='
default boolean	has(org.neo4j.helpers.Args parsedArgs) Returns true if this argument was given explicitly on the command line
String	name() Name of the option as in '--name='
String	optionsListing() Represents the option in the options list.
String	parse(org.neo4j.helpers.Args parsedArgs) Parses the option (or possible default value) out of program arguments.
Collection<String>	parseMultiple(org.neo4j.helpers.Args parsedArgs) Parses the option (or possible default value) out of program arguments.
String	usage() Represents the option in the usage string.

Method Detail

optionsListing

String optionsListing()

Represents the option in the options list.

usage

String usage()

Represents the option in the usage string.

description

String description()

An explanation of the option in the options list.

name

String name()

Name of the option as in '--name='

exampleValue

String exampleValue()

Example value listed in usage between brackets like '--name='

parse

String parse(org.neo4j.helpers.Args parsedArgs)

Parses the option (or possible default value) out of program arguments. Use only if a single argument is allowed.

parseMultiple

Collection<String> parseMultiple(org.neo4j.helpers.Args parsedArgs)

Parses the option (or possible default value) out of program arguments. Use in case multiple arguments are allowed.

has

default boolean has(org.neo4j.helpers.Args parsedArgs)

Returns true if this argument was given explicitly on the command line