minified-utils/com.dervarex.minified.utils.cli

Parser

classinternalSource

public class Parser

CLI Parsing Utility. Usage: 1. Create an Parser Object (with or without prefixes as argument) 2. Register your CLI arguments using Parser.register 3. Give the Parser the String[] args object that you get in your main method

Constructors

Parser()

Source

public Parser()

Will use the default prefix "--"

Parser(String[])

Source

public Parser(String... prefixes)

Constructor with custom prefixes

Parameters
`prefixes`	`String[]`	Prefixes that should be used. It's not recommended to use letters or numbers here, since that can mess with the parsing

Methods

addPrefix(String)

Source

public Parser addPrefix(String prefix)

Adds a prefix after creation of object

Parameters
`prefix`	`String`	Prefix to be added
Returns
`Parser`		Parser object

parse(String[])

Source

public void parse(String[] args)

Parses the given arguments and triggers the registered CLI handlers.

Parameters
`args`	`String[]`	The raw arguments from your main method

register(String, String, NoArgCommand)

Source

public Parser register(String arg, String helpText, NoArgCommand handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`helpText`	`String`	Text to be shown in help
`handler`	`NoArgCommand`	No-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, String, Consumer)

Source

public Parser register(String arg, String helpText, Consumer<String> handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`helpText`	`String`	Text to be shown in help
`handler`	`Consumer<String>`	Single-argument callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, String, TwoArgCommand)

Source

public Parser register(
    String arg,
    String helpText,
    TwoArgCommand<String, String> handler
)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`helpText`	`String`	Text to be shown in help
`handler`	`TwoArgCommand<String, String>`	Two-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, String, ThreeArgCommand)

Source

public Parser register(
    String arg,
    String helpText,
    ThreeArgCommand<String, String, String> handler
)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`helpText`	`String`	Text to be shown in help
`handler`	`ThreeArgCommand<String, String, String>`	Three-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, NoArgCommand)

Source

public Parser register(String arg, NoArgCommand handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`handler`	`NoArgCommand`	No-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, Consumer)

Source

public Parser register(String arg, Consumer<String> handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`handler`	`Consumer<String>`	Single-argument callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, TwoArgCommand)

Source

public Parser register(String arg, TwoArgCommand<String, String> handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`handler`	`TwoArgCommand<String, String>`	Two-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

register(String, ThreeArgCommand)

Source

public Parser register(String arg, ThreeArgCommand<String, String, String> handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`handler`	`ThreeArgCommand<String, String, String>`	Three-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

registerVarArgs(String, String, VarArgsCommand)

Source

public Parser registerVarArgs(String arg, String helpText, VarArgsCommand handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`helpText`	`String`	Text to be shown in help
`handler`	`VarArgsCommand`	Multi-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

registerVarArgs(String, VarArgsCommand)

Source

public Parser registerVarArgs(String arg, VarArgsCommand handler)

Registers a cli argument.

Parameters
`arg`	`String`	Argument
`handler`	`VarArgsCommand`	Multi-arguments callback to be executed once triggered
Returns
`Parser`		Parser object

setDescription(String)

Source

public Parser setDescription(String description)

Sets Description that will get shown in the help message.

Parameters
`description`	`String`	Description to be shown
Returns
`Parser`		Parser object

setPrefixes(String[])

Source

public Parser setPrefixes(String... prefixes)

Overwrites prefixes after creation of object

Parameters
`prefixes`	`String[]`	Updated prefixes list
Returns
`Parser`		Parser object

setProgram(String)

Source

public Parser setProgram(String program)

Sets Program "name". Will get shown in the help message. This should be the command used to launch the program, so either the direct name if registered in the command line or the path to the executable.

Parameters
`program`	`String`	Program name or path
Returns
`Parser`		Parser object

Nested types

Parser.NoArgCommandinterface

No description.

Parser.OneArgCommandinterface

No description.

Parser.TwoArgCommandinterface

No description.

Parser.ThreeArgCommandinterface

No description.

Parser.VarArgsCommandinterface

More than three arguments.