org.neo4j.commandline.arguments

Class OptionalNamedArg

java.lang.Object

org.neo4j.commandline.arguments.OptionalNamedArg

All Implemented Interfaces:

NamedArgument

Direct Known Subclasses:

Database, OptionalBooleanArg, OptionalCanonicalPath, OptionalNamedArgWithMetadata

public class OptionalNamedArg
extends Object
implements NamedArgument

Constructor Summary

Constructors

Constructor and Description
OptionalNamedArg(String name, String[] allowedValues, String defaultValue, String description)
OptionalNamedArg(String name, String exampleValue, String defaultValue, String description)

Method Summary

Modifier and Type	Method and Description
String	defaultValue()
String	description() An explanation of the option in the options list.
String	exampleValue() Example value listed in usage between brackets like '--name='
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.

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

has

Constructor Detail

OptionalNamedArg

public OptionalNamedArg(String name,
                        String exampleValue,
                        String defaultValue,
                        String description)

OptionalNamedArg

public OptionalNamedArg(String name,
                        String[] allowedValues,
                        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

usage

public String usage()

Description copied from interface: NamedArgument

Represents the option in the usage string.

Specified by:

usage in interface NamedArgument

description

public String description()

Description copied from interface: NamedArgument

An explanation of the option in the options list.

Specified by:

description in interface NamedArgument

name

public String name()

Description copied from interface: NamedArgument

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

Specified by:

name in interface NamedArgument

exampleValue

public String exampleValue()

Description copied from interface: NamedArgument

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

Specified by:

exampleValue in interface NamedArgument

defaultValue

public String defaultValue()

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

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