me.piggypiglet.framework.utils.map

Class Maps

java.lang.Object

me.piggypiglet.framework.utils.map.Maps

public class Maps
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Maps.Builder<K,V,R,T>

Method Summary

Modifier and Type	Method and Description
static <K,V,R> Maps.Builder<K,V,R,V>	builder(java.util.Map<K,V> implementation, R returnInstance, java.util.function.Consumer<java.util.Map<K,V>> build) Create an embeddable map builder instance.
static <K,V,R,T> Maps.Builder<K,V,R,T>	builder(java.util.Map<K,V> implementation, R returnInstance, java.util.function.Consumer<java.util.Map<K,V>> build, java.util.function.Function<T,V> mapper) Create an embeddable map builder instance, with a value mapper.
static java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.lang.Object>>	flatten(java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Stream flatMap utility to flatten a map, with "." as the level separator.
static <T> java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.lang.Object>>	flatten(java.util.Map.Entry<java.lang.String,java.lang.Object> entry, java.lang.Class<T> clazz, java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.Object>> flatten) Stream flatMap utility to flatten a map, with "." as the level separator, and a object mapper (triggered if a configured type is detected within a nested map).
static <T> java.util.Map<java.lang.String,java.lang.Object>	map(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.Class<T> clazz, java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.Object>> mapper) Utility method to sort through a map (including nested maps and collections), and replace a specific type, with a Map.
static <K,V> Maps.Builder<K,V,java.util.Map<K,V>,V>	of(java.util.Map<K,V> implementation) Create a Map Builder.
static <K,V,T> Maps.Builder<K,V,java.util.Map<K,V>,T>	of(java.util.Map<K,V> implementation, java.util.function.Function<T,V> mapper) Create a Map Builder with a value mapper.
static <T> T	recursiveGet(java.util.Map<java.lang.String,T> map, java.lang.String path) Utility method to recurse through levels of nested maps to retrieve a specific object, at a path (nested maps separated via "." in the path).

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <K,V,R> Maps.Builder<K,V,R,V> builder(java.util.Map<K,V> implementation,
                                                    R returnInstance,
                                                    java.util.function.Consumer<java.util.Map<K,V>> build)

Create an embeddable map builder instance. Embeddable meaning, the final build() method will return your defined instance, not a Map.

Type Parameters:

K - Key type

V - Value type

R - Return instance type

Parameters:

implementation - Map implementation.

returnInstance - Instance returned on build().

build - Logic to perform on build, to store the Map instance somewhere.

Returns:

Map Builder

builder

public static <K,V,R,T> Maps.Builder<K,V,R,T> builder(java.util.Map<K,V> implementation,
                                                      R returnInstance,
                                                      java.util.function.Consumer<java.util.Map<K,V>> build,
                                                      java.util.function.Function<T,V> mapper)

Create an embeddable map builder instance, with a value mapper. Embeddable meaning, the final build() method return your defined instance, not a Map.

Type Parameters:

K - Key type

V - Value type

R - Return instance type

T - Inputted value type

Parameters:

implementation - Map implementation.

returnInstance - Instance returned on build().

build - Logic to perform on build, to store the Map instance somewhere.

mapper - Value mapper

Returns:

Map Builder

of

public static <K,V> Maps.Builder<K,V,java.util.Map<K,V>,V> of(java.util.Map<K,V> implementation)

Create a Map Builder.

Type Parameters:

K - Key type

V - Value type

Parameters:

implementation - Map implementation

Returns:

Map Builder

of

public static <K,V,T> Maps.Builder<K,V,java.util.Map<K,V>,T> of(java.util.Map<K,V> implementation,
                                                                java.util.function.Function<T,V> mapper)

Create a Map Builder with a value mapper.

Type Parameters:

K - Key type

V - Value type

T - Inputted value type

Parameters:

implementation - Map implementation

mapper - Value mapper

Returns:

Map Builder

flatten

public static java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.lang.Object>> flatten(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Stream flatMap utility to flatten a map, with "." as the level separator.

Parameters:

entry - Entry to flatten

Returns:

Stream of flattened entr(y/ies)

flatten

public static <T> java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.lang.Object>> flatten(java.util.Map.Entry<java.lang.String,java.lang.Object> entry,
                                                                                                          java.lang.Class<T> clazz,
                                                                                                          java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.Object>> flatten)

Stream flatMap utility to flatten a map, with "." as the level separator, and a object mapper (triggered if a configured type is detected within a nested map).

Type Parameters:

T - Type generic of object

Parameters:

entry - Entry to flatten

clazz - Class type of object to detect

flatten - Flatten logic for custom object type

Returns:

Stream of flattened entr(y/ies)

map

public static <T> java.util.Map<java.lang.String,java.lang.Object> map(java.util.Map<java.lang.String,java.lang.Object> map,
                                                                       java.lang.Class<T> clazz,
                                                                       java.util.function.Function<T,java.util.Map<java.lang.String,java.lang.Object>> mapper)

Utility method to sort through a map (including nested maps and collections), and replace a specific type, with a Map.

Type Parameters:

T - Type generic of object

Parameters:

map - Map to map

clazz - Class type of object to detect

mapper - Logic to convert object to map

Returns:

Mapped map

recursiveGet

public static <T> T recursiveGet(java.util.Map<java.lang.String,T> map,
                                 java.lang.String path)

Utility method to recurse through levels of nested maps to retrieve a specific object, at a path (nested maps separated via "." in the path).

Type Parameters:

T - Type generic of object

Parameters:

map - Map to search through

path - Path of object

Returns:

Object located at path