net.sergeych.tools

Class Binder

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

net.sergeych.tools.Binder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

Boss.Dictionary

public class Binder
extends java.util.HashMap<java.lang.String,java.lang.Object>
implements java.io.Serializable

Created by sergeych on 02/12/16.

See Also:

Serialized Form

Nested Class Summary

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static Binder	EMPTY An empty, unmodifiable Binder can be used as a returned value, for example, in an effective way

Constructor Summary

Constructors

Constructor and Description
Binder()
Binder(java.util.Map copyFrom)
Binder(java.lang.Object... keyValuePairs)

Method Summary

Modifier and Type	Method and Description
int	addToInt(java.lang.String name, int delta) Add some delta to a numeric field with a given name that must exist and be convertible to integer.
protected void	checkNotFrozen()
static <T> T	convertAllMapsToBinders(java.lang.Object object) Convert all maps in the object to binders and do it recursively.
void	freeze()
static Binder	from(java.lang.Object x) Convert some map to the binder.
static Binder	fromKeysValues(java.lang.Object... args) Convert "key, value" pairs from varargs into a Params.
java.util.ArrayList<?>	getArray(java.lang.String key)
byte[]	getBinary(java.lang.String key) Get the binary as byte[].
@NonNull byte[]	getBinaryOrThrow(java.lang.String key) Get the binary parameter as byte[] and throws exception if it is missing
Binder	getBinder(java.lang.String key) Return Binder for the key, or empty binder if it does not exist.
Binder	getBinder(java.lang.String key, Binder defaultValue)
Binder	getBinderOrThrow(java.lang.String... path) Create binder using a path, e.g.
Binder	getBinderOrThrow(java.lang.String key)
java.util.ArrayList<Binder>	getBinders(java.lang.String key)
boolean	getBoolean(java.lang.String key) Deprecated.
java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean defaultValue) Get the value as boolean, with given default value if it is missed
java.lang.Boolean	getBooleanOrThrow(java.lang.String key) Get the boolean value of the specivied key or throw
Bytes	getBytesOrThrow(java.lang.String key)
java.lang.Double	getDouble(java.lang.String key)
int	getInt(java.lang.String key) Deprecated.
java.lang.Integer	getInt(java.lang.String key, java.lang.Integer defaultValue)
int	getIntOrThrow(java.lang.String key)
<T> java.util.List<T>	getList(java.lang.String key, java.util.List<T> defaultValue)
java.util.List	getListOrThrow(java.lang.String key)
long	getLong(java.lang.String key) Deprecated.
long	getLong(java.lang.String key, long defaultValue)
long	getLongOrThrow(java.lang.String key)
Binder	getOrCreateBinder(java.lang.String key)
<T> java.util.List<T>	getOrCreateList(java.lang.String key) Get object as list, or create empty list if it is empty
<T> T	getOrNull(java.lang.String... path)
<T> T	getOrThrow(java.lang.String... path)
<T> T	getOrThrow(java.lang.String key) Get object at key or throw IllegalArgumentException.
java.lang.String	getString(java.lang.String key) Compatibility method.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue)
java.lang.String	getStringOrThrow(java.lang.String... path)
java.lang.String	getStringOrThrow(java.lang.String key) Get the parameter as string.
java.time.ZonedDateTime	getZonedDateTime(java.lang.String key, java.time.ZonedDateTime defaultValue)
java.time.ZonedDateTime	getZonedDateTimeOrThrow(java.lang.String key)
boolean	isFrozen()
static Binder	of(java.lang.Object x) Convert some map to the binder.
Binder	of(java.lang.String key) Deprecated.
static Binder	of(java.lang.String key, java.lang.Object value, java.lang.Object... keysValues) Just like in Java 9, create a binder of keys and values, but, IMPOTANT, returned Binder is not immutable! Freeze it if need.
Binder	putAll(java.lang.String key, java.lang.Object value, java.lang.Object... keyValuePairs) Put several keys and values from array varargs.
<T> T	set(java.lang.String key, T object) Add Binder as a field with the specified index and return it in a typed manner.
Binder	unmodifiableCopy()

Methods inherited from class java.util.HashMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

EMPTY

public static final Binder EMPTY

An empty, unmodifiable Binder can be used as a returned value, for example, in an effective way

Constructor Detail

Binder

public Binder(java.util.Map copyFrom)

Binder

public Binder()

Binder

public Binder(java.lang.Object... keyValuePairs)

Method Detail

fromKeysValues

public static Binder fromKeysValues(java.lang.Object... args)

Convert "key, value" pairs from varargs into a Params.

Parameters:

args - key, value pairs.Can be 0 length or any even length.

Returns:

filled Map instance

isFrozen

public boolean isFrozen()

checkNotFrozen

protected void checkNotFrozen()

getDouble

public java.lang.Double getDouble(java.lang.String key)

getStringOrThrow

public java.lang.String getStringOrThrow(java.lang.String key)
                                  throws java.lang.IllegalArgumentException

Get the parameter as string. Throws exception if it is missing.

Parameters:

key -

Returns:

string paramter

Throws:

java.lang.IllegalArgumentException - if the parameter does not exist

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

getString

public java.lang.String getString(java.lang.String key)
                           throws java.lang.IllegalArgumentException

Compatibility method. Same as getStringOrThrow(String).

Throws:

java.lang.IllegalArgumentException

getBinary

public byte[] getBinary(java.lang.String key)

Get the binary as byte[]. If the data are in the improper format, throws exception.

Parameters:

key -

Returns:

data or null if key is missing

getBinaryOrThrow

public @NonNull byte[] getBinaryOrThrow(java.lang.String key)
                                 throws java.lang.IllegalArgumentException

Get the binary parameter as byte[] and throws exception if it is missing

Parameters:

key -

Returns:

Throws:

java.lang.IllegalArgumentException

getBoolean

@Deprecated
public boolean getBoolean(java.lang.String key)

Deprecated.

Get the boolean value, return false if not found, same as if found 'false'. We recommend to use either getBoolean(String, Boolean) } or getBinaryOrThrow(String) to resolve this ambigity.

Parameters:

key -

Returns:

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key,
                                    java.lang.Boolean defaultValue)

Get the value as boolean, with given default value if it is missed

Parameters:

key - name of the parameter

defaultValue - value to return if missing

Returns:

value found in mao or the defaultValue

getBooleanOrThrow

public java.lang.Boolean getBooleanOrThrow(java.lang.String key)
                                    throws java.lang.IllegalArgumentException

Get the boolean value of the specivied key or throw

Parameters:

key - to search

Returns:

value as boolean

Throws:

java.lang.IllegalArgumentException - if key not found

of

@Deprecated
public Binder of(java.lang.String key)

Deprecated.

Get the sub-hash with the given name. Works even if there is no such sub-params:

params.of("some").of("non-existing").of("path").getStringOrThrow("foo") == null

will work as expected.

Parameters:

key - key name

Returns:

either the sub-hash or new empty hash.

of

public static Binder of(java.lang.String key,
                        java.lang.Object value,
                        java.lang.Object... keysValues)

Just like in Java 9, create a binder of keys and values, but, IMPOTANT, returned Binder is not immutable! Freeze it if need.

Parameters:

key -

value -

keysValues -

Returns:

getOrCreateBinder

public Binder getOrCreateBinder(java.lang.String key)

getBinder

public Binder getBinder(java.lang.String key)

Return Binder for the key, or empty binder if it does not exist.

Parameters:

key -

Returns:

getBinderOrThrow

public Binder getBinderOrThrow(java.lang.String key)

getBinder

public Binder getBinder(java.lang.String key,
                        Binder defaultValue)

getInt

@Deprecated
public int getInt(java.lang.String key)

Deprecated.

Use getIntOrThrow(String) instead.

Parameters:

key - parameter name

Returns:

parameter value or throws IllegalArgumentException.

getIntOrThrow

public int getIntOrThrow(java.lang.String key)

Parameters:

key - parameter name

Returns:

parameter value or throws IllegalArgumentException.

getLong

@Deprecated
public long getLong(java.lang.String key)

Deprecated.

Use getLongOrThrow(String) instead.

Parameters:

key -

Returns:

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

getInt

public java.lang.Integer getInt(java.lang.String key,
                                java.lang.Integer defaultValue)

getArray

public java.util.ArrayList<?> getArray(java.lang.String key)

getBinders

public java.util.ArrayList<Binder> getBinders(java.lang.String key)

set

public <T> T set(java.lang.String key,
                 T object)

Add Binder as a field with the specified index and return it in a typed manner. Sort of the syntax sugar.

Parameters:

key -

object -

Returns:

unmodifiableCopy

public Binder unmodifiableCopy()

freeze

public void freeze()

from

public static Binder from(java.lang.Object x)

Convert some map to the binder. Do nothing if it is already a binder. Otherwise pack Map into a Binder.

Parameters:

x - source map

convertAllMapsToBinders

public static <T> T convertAllMapsToBinders(java.lang.Object object)

Convert all maps in the object to binders and do it recursively.

Parameters:

object - source map

of

public static Binder of(java.lang.Object x)

Convert some map to the binder. Do nothing if it is already a binder.

Parameters:

x - source map

putAll

public Binder putAll(java.lang.String key,
                     java.lang.Object value,
                     java.lang.Object... keyValuePairs)

Put several keys and values from array varargs. Sample: setKeysValues("foo", 1, "bar", 2);

Parameters:

keyValuePairs -

Returns:

self

getZonedDateTime

public java.time.ZonedDateTime getZonedDateTime(java.lang.String key,
                                                java.time.ZonedDateTime defaultValue)

getZonedDateTimeOrThrow

public java.time.ZonedDateTime getZonedDateTimeOrThrow(java.lang.String key)

getLongOrThrow

public long getLongOrThrow(java.lang.String key)

getBytesOrThrow

public Bytes getBytesOrThrow(java.lang.String key)

getOrThrow

public <T> T getOrThrow(java.lang.String key)

Get object at key or throw IllegalArgumentException. Important. This method throw exception if the value not found in the map, or if the value is null, and also if the value can't be casted to T. do not use it if nulls are valid values.

Type Parameters:

T -

Parameters:

key -

Returns:

getOrCreateList

public <T> java.util.List<T> getOrCreateList(java.lang.String key)

Get object as list, or create empty list if it is empty

Type Parameters:

T -

Parameters:

key -

Returns:

list instance, not null.

getList

public <T> java.util.List<T> getList(java.lang.String key,
                                     java.util.List<T> defaultValue)

getListOrThrow

public java.util.List getListOrThrow(java.lang.String key)

addToInt

public int addToInt(java.lang.String name,
                    int delta)

Add some delta to a numeric field with a given name that must exist and be convertible to integer. After hte operation the modified value of type Integer is stored in this binder

Parameters:

name -

delta -

Returns:

new value

getBinderOrThrow

public Binder getBinderOrThrow(java.lang.String... path)

Create binder using a path, e.g. calling getBinderOrThrow(String) sequentally to all strings in path argument array. For example

     Binder res = source.getBinderOrThrow("foo", "bar", "baz")
 

does exactly same as

     Binder res = source.getBinderOrThrow("foo").getBinderOrThrow("bar").getBinderOrThrow("baz");
 

Parameters:

path - array of pah components

Returns:

nonnull Binder instance

Throws:

java.lang.IllegalArgumentException - if such a binder does not exist in this Binder

getStringOrThrow

public java.lang.String getStringOrThrow(java.lang.String... path)

getOrThrow

public <T> T getOrThrow(java.lang.String... path)

getOrNull

public <T> T getOrNull(java.lang.String... path)