ArgumentReader (command-line-util 1.1.8 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.concurrent.ConcurrentHashMap<String,List<String>>
  - - berlin.yuna.clu.logic.ArgumentReader

All Implemented Interfaces:

Serializable, ConcurrentMap<String,List<String>>, Map<String,List<String>>
```
public class ArgumentReader
extends ConcurrentHashMap<String,List<String>>
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap
  ConcurrentHashMap.KeySetView<K,V>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

protected List<String> commandList

Fields
Modifier and Type	Field and Description
`protected List<String>`	`commandList`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ArgumentReader(boolean parseEnv, String... args)
Parses a string arguments into key value

Constructors
Modifier	Constructor and Description
`protected`	`ArgumentReader(boolean parseEnv, String... args)` Parses a string arguments into key value

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ArgumentReader`	`addCommands(String[] cmdList)`
`protected ArgumentReader`	`addKV(String key, String value)`
`boolean`	`equals(Object o)`
`List<String>`	`get(String key)` get
`List<String>`	`get(String separator, String key)` get
`boolean`	`getBoolean(int index, String... keys)` getBoolean
`boolean`	`getBoolean(String... keys)` getBoolean
`boolean`	`getBoolean(String separator, int index, String... keys)` getBoolean
`List<Boolean>`	`getBooleans(String... keys)` getBoolean
`List<Boolean>`	`getBooleans(String separator, String[] keys)` getBoolean
`String`	`getCommand()` get command
`String`	`getCommand(int index)` get command
`List<String>`	`getCommands()` get commands
`Optional<Double>`	`getDouble(int index, String... keys)` getDouble
`Optional<Double>`	`getDouble(String... keys)` getDouble
`Optional<Double>`	`getDouble(String separator, int index, String... keys)` getDouble
`List<Double>`	`getDoubles(char separator, String... keys)` getDoubles
`List<Double>`	`getDoubles(String... keys)` getDoubles
`List<Double>`	`getDoubles(String separator, String[] keys)` getDoubles
`Optional<Long>`	`getLong(int index, String... keys)` getLong
`Optional<Long>`	`getLong(String... keys)`
`Optional<Long>`	`getLong(String separator, int index, String... keys)` getLong
`List<Long>`	`getLongs(char separator, String... keys)` getLongs
`List<Long>`	`getLongs(String... keys)` getLongs
`List<Long>`	`getLongs(String separator, String[] keys)` getLongs
`Optional<String>`	`getString(int index, String... keys)` getString
`Optional<String>`	`getString(String... keys)` getString
`Optional<String>`	`getString(String separator, int index, String... keys)` getString
`List<String>`	`getStrings(char separator, String... keys)` getStrings
`List<String>`	`getStrings(String... keys)` getStrings
`List<String>`	`getStrings(String separator, String[] keys)` getStrings
`protected String`	`getStripedValue(String value)`
`protected String`	`getValue(String separator, int index, String... keys)` getValue
`protected List<String>`	`getValues(String separator, String[] keys)`
`boolean`	`hasCommand(String command)` has command
`int`	`hashCode()`
`boolean`	`isPresent(String... keys)` isPresent
`static ArgumentReader`	`parseArgs(boolean parseEnv, String... args)` Parses a string arguments into key values example: [mvn clean install --Dencoding="UTF-8", --javaVersion 8 -v=true --args=1,2,3] example (commands): [mvn, clean, install] example (kv): [Dencoding=UTF-8, javaVersion=8, v=true, args=1,2,3] See: `getString(String, int, String...)` `getLong(String, int, String...)` `getDouble(String, int, String...)` `getValue(String, int, String...)` `get(String, String)` `getCommands()` `hasCommand(String)`
`static ArgumentReader`	`parseArgs(String... args)` Parses a string arguments into key values example: [mvn clean install --Dencoding="UTF-8", --javaVersion 8 -v=true --args=1,2,3] example (commands): [mvn, clean, install] example (kv): [Dencoding=UTF-8, javaVersion=8, v=true, args=1,2,3] See: `getString(String, int, String...)` `getLong(String, int, String...)` `getDouble(String, int, String...)` `getValue(String, int, String...)` `get(String, String)` `getCommands()` `hasCommand(String)`
`protected ArgumentReader`	`parseCommandLine(String input)`
`protected String`	`parseCommands(String input)`
`ArgumentReader`	`parseEnvironment()`
`protected String[]`	`parseToKeyValue(String argument)`
`protected List<String>`	`removeDuplicates(List<String> result)`
`protected Function<String,Boolean>`	`toBoolean()`
`protected Function<String,Double>`	`toDouble()`
`protected Function<String,Long>`	`toLong()`

Methods inherited from class java.util.concurrent.ConcurrentHashMap
clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.util.AbstractMap
clone

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - commandList
```
protected final List<String> commandList
```
- Constructor Detail
  - ArgumentReader
```
protected ArgumentReader(boolean parseEnv,
                         String... args)
```
    Parses a string arguments into key value
    
    Parameters:
    
    args - strings with arguments
- Method Detail
  - parseArgs
```
public static ArgumentReader parseArgs(String... args)
```
    Parses a string arguments into key values
    example: [mvn clean install --Dencoding="UTF-8", --javaVersion 8 -v=true --args=1,2,3]
    example (commands): [mvn, clean, install]
    example (kv): [Dencoding=UTF-8, javaVersion=8, v=true, args=1,2,3]
    See:
    getString(String, int, String...)
    getLong(String, int, String...)
    getDouble(String, int, String...)
    getValue(String, int, String...)
    get(String, String)
    getCommands()
    hasCommand(String)
    
    Parameters:
    
    args - strings with arguments
  - parseArgs
```
public static ArgumentReader parseArgs(boolean parseEnv,
                                       String... args)
```
    Parses a string arguments into key values
    example: [mvn clean install --Dencoding="UTF-8", --javaVersion 8 -v=true --args=1,2,3]
    example (commands): [mvn, clean, install]
    example (kv): [Dencoding=UTF-8, javaVersion=8, v=true, args=1,2,3]
    See:
    getString(String, int, String...)
    getLong(String, int, String...)
    getDouble(String, int, String...)
    getValue(String, int, String...)
    get(String, String)
    getCommands()
    hasCommand(String)
    
    Parameters:
    
    args - strings with arguments
    
    parseEnv - if true, will also parse environment variables
  - getCommand
```
public String getCommand()
```
    get command
    
    Returns:
    
    command
  - getCommand
```
public String getCommand(int index)
```
    get command
    
    Parameters:
    
    index - number of command
    
    Returns:
    
    command or null if no command were found
  - getCommands
```
public List<String> getCommands()
```
    get commands
    
    Returns:
    
    all commands
  - hasCommand
```
public boolean hasCommand(String command)
```
    has command
    
    Returns:
    
    true if command exists
  - isPresent
```
public boolean isPresent(String... keys)
```
    isPresent
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    true if one key is present
  - getString
```
public Optional<String> getString(String... keys)
```
    getString
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    returns Optional value or Optional.empty() if no value is present
  - getString
```
public Optional<String> getString(int index,
                                  String... keys)
```
    getString
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    Returns:
    
    returns Optional value or Optional.empty() if no value is present
  - getString
```
public Optional<String> getString(String separator,
                                  int index,
                                  String... keys)
```
    getString
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    separator - handles values as list if present
    
    Returns:
    
    returns Optional value or Optional.empty() if no value is present
  - getStrings
```
public List<String> getStrings(String... keys)
```
    getStrings
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    returns values or empty list if no value is present
  - getStrings
```
public List<String> getStrings(char separator,
                               String... keys)
```
    getStrings
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    returns values or empty list if no value is present
  - getStrings
```
public List<String> getStrings(String separator,
                               String[] keys)
```
    getStrings
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    returns values or empty list if no value is present
  - getBoolean
```
public boolean getBoolean(String... keys)
```
    getBoolean
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    true if [value == 1], [value == true], [key != && value == null]
  - getBoolean
```
public boolean getBoolean(int index,
                          String... keys)
```
    getBoolean
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    Returns:
    
    true if [value == 1], [value == true], [key != && value == null]
  - getBoolean
```
public boolean getBoolean(String separator,
                          int index,
                          String... keys)
```
    getBoolean
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    separator - handles values as list if present
    
    Returns:
    
    true if [value == 1], [value == true], [key != && value == null]
  - getBooleans
```
public List<Boolean> getBooleans(String... keys)
```
    getBoolean
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    boolean list if [value == 1], [value == true]
  - getBooleans
```
public List<Boolean> getBooleans(String separator,
                                 String[] keys)
```
    getBoolean
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    boolean list if [value == 1], [value == true]
  - getLong
```
public Optional<Long> getLong(String... keys)
```
  - getLong
```
public Optional<Long> getLong(int index,
                              String... keys)
```
    getLong
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getLong
```
public Optional<Long> getLong(String separator,
                              int index,
                              String... keys)
```
    getLong
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getLongs
```
public List<Long> getLongs(String... keys)
```
    getLongs
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getLongs
```
public List<Long> getLongs(char separator,
                           String... keys)
```
    getLongs
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getLongs
```
public List<Long> getLongs(String separator,
                           String[] keys)
```
    getLongs
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDouble
```
public Optional<Double> getDouble(String... keys)
```
    getDouble
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDouble
```
public Optional<Double> getDouble(int index,
                                  String... keys)
```
    getDouble
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDouble
```
public Optional<Double> getDouble(String separator,
                                  int index,
                                  String... keys)
```
    getDouble
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDoubles
```
public List<Double> getDoubles(String... keys)
```
    getDoubles
    
    Parameters:
    
    keys - search for
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDoubles
```
public List<Double> getDoubles(char separator,
                               String... keys)
```
    getDoubles
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - getDoubles
```
public List<Double> getDoubles(String separator,
                               String[] keys)
```
    getDoubles
    
    Parameters:
    
    keys - search for
    
    separator - handles values as list if present
    
    Returns:
    
    Optional of Long if [value is an integer]
  - get
```
public List<String> get(String key)
```
    get
    
    Parameters:
    
    key - search for
    
    Returns:
    
    list of values or empty list if not found
  - get
```
public List<String> get(String separator,
                        String key)
```
    get
    
    Parameters:
    
    key - search for
    
    separator - handles values as list if present
    
    Returns:
    
    list of values or empty list if not found
  - removeDuplicates
```
protected List<String> removeDuplicates(List<String> result)
```
  - parseEnvironment
```
public ArgumentReader parseEnvironment()
```
  - parseCommandLine
```
protected ArgumentReader parseCommandLine(String input)
```
  - addKV
```
protected ArgumentReader addKV(String key,
                               String value)
```
  - parseCommands
```
protected String parseCommands(String input)
```
  - addCommands
```
protected ArgumentReader addCommands(String[] cmdList)
```
  - getStripedValue
```
protected String getStripedValue(String value)
```
  - parseToKeyValue
```
protected String[] parseToKeyValue(String argument)
```
  - getValues
```
protected List<String> getValues(String separator,
                                 String[] keys)
```
  - getValue
```
protected String getValue(String separator,
                          int index,
                          String... keys)
```
    getValue
    
    Parameters:
    
    keys - search for
    
    index - number of value
    
    separator - handles values as list if present
    
    Returns:
    
    value or null if no value was found
  - toBoolean
```
protected Function<String,Boolean> toBoolean()
```
  - toLong
```
protected Function<String,Long> toLong()
```
  - toDouble
```
protected Function<String,Double> toDouble()
```
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,List<String>>
    
    Overrides:
    
    equals in class ConcurrentHashMap<String,List<String>>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,List<String>>
    
    Overrides:
    
    hashCode in class ConcurrentHashMap<String,List<String>>

Class ArgumentReader

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.concurrent.ConcurrentHashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Field Detail

commandList

Constructor Detail

ArgumentReader

Method Detail

parseArgs

parseArgs

getCommand

getCommand

getCommands

hasCommand

isPresent

getString

getString

getString

getStrings

getStrings

getStrings

getBoolean

getBoolean

getBoolean

getBooleans

getBooleans

getLong

getLong

getLong

getLongs

getLongs

getLongs

getDouble

getDouble

getDouble

getDoubles

getDoubles

getDoubles

get

get

removeDuplicates

parseEnvironment

parseCommandLine

addKV

parseCommands

addCommands

getStripedValue

parseToKeyValue

getValues

getValue

toBoolean

toLong

toDouble

equals

hashCode