com.github.brunoais.cli_args_parser

Class ParseArgs

java.lang.Object

com.github.brunoais.cli_args_parser.ParseArgs

public class ParseArgs
extends Object

Simple Arguments parser

Author:

brunoais

Constructor Summary

Constructors

Constructor and Description
ParseArgs()

Method Summary

Modifier and Type	Method and Description
Argument	argument() Creates a new Argument to parse the default arguments
Argument	argument(String name) Creates a new Argument to parse input Provide a null name if it is a default argument
void	parseArgs(String[] args) Parses the args array fully
void	parseArgs(String[] args, int start) Parses the args array fully from start (inclusive)
void	parseArgs(String[] args, int start, int end) Parses the args array from start (inclusive) to end (exclusive)
ValCallback	unknownArgCallback(ValCallback notFoundArgument) Sets the callback for when an argument is included but no correspondence was found

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseArgs

public ParseArgs()

Method Detail

argument

public Argument argument()

Creates a new Argument to parse the default arguments

Returns:

A new Argument for the default arguments for configuration

argument

public Argument argument(String name)

Creates a new Argument to parse input Provide a null name if it is a default argument

Parameters:

name - The name of the argument

Returns:

A new Argument for this name for configuration

unknownArgCallback

public ValCallback unknownArgCallback(ValCallback notFoundArgument)

Sets the callback for when an argument is included but no correspondence was found

Parameters:

notFoundArgument - The callback called if an unknown argument is found

Returns:

the previous callback. Null otherwise

parseArgs

public void parseArgs(String[] args)

Parses the args array fully

Parameters:

args - The args array to parse

parseArgs

public void parseArgs(String[] args,
                      int start)

Parses the args array fully from start (inclusive)

Parameters:

args - The args array to parse

start - The first index of args array to parse

parseArgs

public void parseArgs(String[] args,
                      int start,
                      int end)
               throws ArrayIndexOutOfBoundsException

Parses the args array from start (inclusive) to end (exclusive)

Parameters:

args - The args array to parse

start - The first index of args array to parse

end - The (last - 1) index of args array to parse

Throws:

ArrayIndexOutOfBoundsException - if: * start < 0 || end > args.lengh * args ended too soon when trying to parse a value with spaces