org.neo4j.commandline.arguments

Class Arguments

java.lang.Object

org.neo4j.commandline.arguments.Arguments

public class Arguments
extends Object

Builder class for constructing a suitable arguments-string for displaying in help messages and alike. Some common arguments have convenience functions.

Field Summary

Fields

Modifier and Type	Field and Description
static Arguments	NO_ARGS

Constructor Summary

Constructors

Constructor and Description
Arguments()

Method Summary

Modifier and Type	Method and Description
String	description(String text)
String	formatArgumentDescription(int longestAlignmentLength, NamedArgument argument)
String	get(int pos)
String	get(String argName)
<T> T	get(String argName, Function<String,T> converter)
boolean	getBoolean(String argName)
Path	getMandatoryPath(String argName)
Optional<Path>	getOptionalPath(String argName)
boolean	has(String argName)
Arguments	parse(String[] args)
static String	rightColumnFormatted(String leftText, String rightText, int rightAlignIndex)
String	usage()
Arguments	withAdditionalConfig()
Arguments	withArgument(NamedArgument namedArgument)
Arguments	withDatabase()
Arguments	withMandatoryPositionalArgument(int position, String value)
Arguments	withOptionalPositionalArgument(int position, String value)
Arguments	withPositionalArgument(PositionalArgument arg)
Arguments	withTo(String description)
static String	wrapText(String text, int lineLength) Original line-endings in the text are respected.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGS

public static final Arguments NO_ARGS

Constructor Detail

Arguments

public Arguments()

Method Detail

withDatabase

public Arguments withDatabase()

withAdditionalConfig

public Arguments withAdditionalConfig()

withTo

public Arguments withTo(String description)

withOptionalPositionalArgument

public Arguments withOptionalPositionalArgument(int position,
                                                String value)

withMandatoryPositionalArgument

public Arguments withMandatoryPositionalArgument(int position,
                                                 String value)

withArgument

public Arguments withArgument(NamedArgument namedArgument)

withPositionalArgument

public Arguments withPositionalArgument(PositionalArgument arg)

usage

public String usage()

description

public String description(String text)

wrapText

public static String wrapText(String text,
                              int lineLength)

Original line-endings in the text are respected.

Parameters:

text - to wrap

lineLength - no line will exceed this length

Returns:

the text where no line exceeds the specified length

formatArgumentDescription

public String formatArgumentDescription(int longestAlignmentLength,
                                        NamedArgument argument)

rightColumnFormatted

public static String rightColumnFormatted(String leftText,
                                          String rightText,
                                          int rightAlignIndex)

parse

public Arguments parse(String[] args)
                throws IncorrectUsage

Throws:

IncorrectUsage

get

public String get(int pos)

get

public String get(String argName)

getBoolean

public boolean getBoolean(String argName)

getOptionalPath

public Optional<Path> getOptionalPath(String argName)

getMandatoryPath

public Path getMandatoryPath(String argName)

get

public <T> T get(String argName,
                 Function<String,T> converter)

has

public boolean has(String argName)

Parameters:

argName - name of argument

Returns:

true if argName was given as an explicit argument, false otherwise