org.neo4j.commandline.arguments

Class OptionalNamedArgWithMetadata

java.lang.Object

org.neo4j.commandline.arguments.OptionalNamedArg

org.neo4j.commandline.arguments.OptionalNamedArgWithMetadata

All Implemented Interfaces:

NamedArgument

public class OptionalNamedArgWithMetadata
extends OptionalNamedArg
implements NamedArgument

Some arguments can have a variable name, such as in neo4j-admin import where the `--relationships` argument may have the following form: --relationships:MYTYPE=file.csv or the `--nodes` argument which can be --nodes:TYPE1:TYPE2=file.csv This is only used for validation, not to actually read the metadata. See ImportCommand.java.

Constructor Summary

Constructors

Constructor and Description
OptionalNamedArgWithMetadata(String name, String exampleMetaData, String exampleValue, String defaultValue, String description)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class org.neo4j.commandline.arguments.OptionalNamedArg

defaultValue, description, exampleValue, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.commandline.arguments.NamedArgument

description, exampleValue, has, name

Constructor Detail

OptionalNamedArgWithMetadata

public OptionalNamedArgWithMetadata(String name,
                                    String exampleMetaData,
                                    String exampleValue,
                                    String defaultValue,
                                    String description)

Method Detail

optionsListing

public String optionsListing()

Description copied from interface: NamedArgument

Represents the option in the options list.

Specified by:

optionsListing in interface NamedArgument

Overrides:

optionsListing in class OptionalNamedArg

usage

public String usage()

Description copied from interface: NamedArgument

Represents the option in the usage string.

Specified by:

usage in interface NamedArgument

Overrides:

usage in class OptionalNamedArg

parse

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

Description copied from interface: NamedArgument

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

Specified by:

parse in interface NamedArgument

Overrides:

parse in class OptionalNamedArg

parseMultiple

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

Description copied from interface: NamedArgument

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

Specified by:

parseMultiple in interface NamedArgument

Overrides:

parseMultiple in class OptionalNamedArg