Package uk.ac.ebi.utils.collections

Interface OptionsMap

All Superinterfaces:

Map<String,Object>

All Known Implementing Classes:

OptionsMapWrapper

public interface OptionsMap
extends Map<String,Object>

A variant of the map interface that has the purpose of easing the manipulation of options based on string values. These are typically fetched from Properties and the like. See unit tests for details.

Author:

brandizi

Date:

16 Sep 2020

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
static OptionsMap	create()	This is based on OptionsMapWrapper.
static OptionsMap	from(Map<String,Object> base)	This is based on OptionsMapWrapper.
static OptionsMap	from(Properties base)	This is based on OptionsMapWrapper
default Boolean	getBoolean(String key)
default Boolean	getBoolean(String key, Boolean defaultValue)
default Double	getDouble(String key)
default Double	getDouble(String key, Double defaultValue)
default Integer	getInt(String key)
default Integer	getInt(String key, Integer defaultValue)
default Long	getLong(String key)
default Long	getLong(String key, Long defaultValue)
default <V> V	getOpt(String key)	null as default value and no conversion
default <V> V	getOpt(String key, Function<String,V> converter)	Default is null
default <V> V	getOpt(String key, V defaultValue)	No conversion, returned value type depends on what it was stored
default <V> V	getOpt(String key, V defaultValue, Function<String,V> converter)	Convert a string value returned by the key using the converter parameter.
default String	getString(String key)
default String	getString(String key, String defaultValue)	Expects the key to return a string and returns it as-is.
static OptionsMap	unmodifiableOptionsMap(Map<String,Object> base)	This is simply the chaining of from(Map) and Collections.unmodifiableMap(Map), ie, returns a read-only options map.
static OptionsMap	unmodifiableOptionsMap(Properties base)

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Details

getOpt

default <V> V getOpt(String key,
 V defaultValue,
 Function<String,V> converter)

Convert a string value returned by the key using the converter parameter. If the key is null, returns the default If it's a string, returns the result of the conversion Else, casts it to V, possibly raising ClassCastException The idea is that we're dealing with a mix of object values or string values that might represent some other types. This is a base for other specific methods (eg, getDouble(String, Double). *

getOpt

default <V> V getOpt(String key,
 Function<String,V> converter)

Default is null

getOpt

default <V> V getOpt(String key,
 V defaultValue)

No conversion, returned value type depends on what it was stored

getOpt

default <V> V getOpt(String key)

null as default value and no conversion

getDouble

default Double getDouble(String key,
 Double defaultValue)

getDouble

default Double getDouble(String key)

getInt

default Integer getInt(String key,
 Integer defaultValue)

getInt

default Integer getInt(String key)

getLong

default Long getLong(String key,
 Long defaultValue)

getLong

default Long getLong(String key)

getString

default String getString(String key,
 String defaultValue)

Expects the key to return a string and returns it as-is. In other words, this is just to make the type casting easier.

getString

default String getString(String key)

getBoolean

default Boolean getBoolean(String key,
 Boolean defaultValue)

getBoolean

default Boolean getBoolean(String key)

from

static OptionsMap from(Map<String,Object> base)

This is based on OptionsMapWrapper.

from

static OptionsMap from(Properties base)

This is based on OptionsMapWrapper

create

static OptionsMap create()

This is based on OptionsMapWrapper.

unmodifiableOptionsMap

static OptionsMap unmodifiableOptionsMap(Map<String,Object> base)

This is simply the chaining of from(Map) and Collections.unmodifiableMap(Map), ie, returns a read-only options map.

unmodifiableOptionsMap

static OptionsMap unmodifiableOptionsMap(Properties base)