Package com.composum.sling.core.util

Class StructuredValueMap

java.lang.Object

com.composum.sling.core.util.StructuredValueMap

All Implemented Interfaces:

Map<String,Object>, org.apache.sling.api.resource.ValueMap

public class StructuredValueMap
extends Object
implements org.apache.sling.api.resource.ValueMap

A ValueMap which supports nested maps and resolves paths to properties of nested maps. This is useful if you want to use placeholders for a complex set of values, e.g. in a ValueEmbeddingReader. You can use either a path (delimiter: '/') or an object (delimiter: '.') notation, e.g. ${nested/immediate/prop} or ${nested.immediate.prop}. the path notation has precedence over the object notation, e.g. ${nested/prop.name} references the 'prop.name' property of the 'nested' map.

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.sling.api.resource.ValueMap	base

Fields inherited from interface org.apache.sling.api.resource.ValueMap

EMPTY

Constructor Summary

Constructors

Constructor	Description
StructuredValueMap(Map<String,Object> base)

Method Summary

Modifier and Type	Method	Description
protected boolean	_containsKey(@NotNull String name)
protected boolean	_containsKey(@NotNull String name, @NotNull Map<String,Object> map, @NotNull String delimiter)
protected boolean	_containsValue(@NotNull Object value)
protected boolean	_containsValue(@NotNull Object value, @NotNull Map<String,Object> map)
protected Object	_get(@NotNull String name, @Nullable Class<?> type)
protected Object	_get(@NotNull String name, @Nullable Class<?> type, @NotNull Map<String,Object> map, @NotNull String delimiter)
protected Object	_get(@NotNull Map<String,Object> map, @NotNull String name, @Nullable Class<?> type)
protected void	_keySet(Map<String,Object> map, Set<String> result, String prefix)
protected Object	_put(@NotNull String name, @Nullable Object value)
protected Object	_put(@NotNull String name, @Nullable Object value, @NotNull Map<String,Object> map, @NotNull String delimiter)
protected Object	_remove(@NotNull String name)
protected Object	_remove(@NotNull String name, @NotNull Map<String,Object> map, @NotNull String delimiter)
protected int	_size(Map<String,Object> map)
protected void	_values(Map<String,Object> map, Collection<Object> result)
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
@NotNull Set<Map.Entry<String,Object>>	entrySet()
<T> T	get(@NotNull String name, @NotNull Class<T> type)
<T> T	get(@NotNull String name, T defaultValue)
Object	get(Object key)
boolean	isEmpty()
@NotNull Set<String>	keySet()
@Nullable Object	put(String key, Object value)	puts a new value at the path given by the name; if path starts with '/' the path delimiter is used to build nested maps but ignored in the key
void	putAll(@NotNull Map<? extends String,?> m)
Object	remove(Object key)
int	size()
@NotNull Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

base

protected final org.apache.sling.api.resource.ValueMap base

Constructor Detail

StructuredValueMap

public StructuredValueMap(Map<String,Object> base)

Method Detail

get

public <T> T get(@NotNull
                 @NotNull String name,
                 @NotNull
                 @NotNull Class<T> type)

Specified by:

get in interface org.apache.sling.api.resource.ValueMap

get

@NotNull
public <T> T get(@NotNull
                 @NotNull String name,
                 @NotNull
                 T defaultValue)

Specified by:

get in interface org.apache.sling.api.resource.ValueMap

size

public int size()

Specified by:

size in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

put

@Nullable
public @Nullable Object put(String key,
                            Object value)

puts a new value at the path given by the name; if path starts with '/' the path delimiter is used to build nested maps but ignored in the key

Specified by:

put in interface Map<String,Object>

Parameters:

key - the key (the path) of the value to store

value - the value to store

Returns:

the removed value; maybe 'null'

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(@NotNull
                   @NotNull Map<? extends String,?> m)

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

@NotNull
public @NotNull Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

Returns:

the stripped set of keys including nested keys as paths and excluding the nested maps itself

values

@NotNull
public @NotNull Collection<Object> values()

Specified by:

values in interface Map<String,Object>

Returns:

the stripped set of values including nested values and excluding the nested maps itself

entrySet

@NotNull
public @NotNull Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Returns:

the entry set of the base map, no nested members stripped

_get

protected Object _get(@NotNull
                      @NotNull String name,
                      @Nullable
                      @Nullable Class<?> type)

_get

protected Object _get(@NotNull
                      @NotNull String name,
                      @Nullable
                      @Nullable Class<?> type,
                      @NotNull
                      @NotNull Map<String,Object> map,
                      @NotNull
                      @NotNull String delimiter)

_get

protected Object _get(@NotNull
                      @NotNull Map<String,Object> map,
                      @NotNull
                      @NotNull String name,
                      @Nullable
                      @Nullable Class<?> type)

_put

protected Object _put(@NotNull
                      @NotNull String name,
                      @Nullable
                      @Nullable Object value)

_put

protected Object _put(@NotNull
                      @NotNull String name,
                      @Nullable
                      @Nullable Object value,
                      @NotNull
                      @NotNull Map<String,Object> map,
                      @NotNull
                      @NotNull String delimiter)

_remove

protected Object _remove(@NotNull
                         @NotNull String name)

_remove

protected Object _remove(@NotNull
                         @NotNull String name,
                         @NotNull
                         @NotNull Map<String,Object> map,
                         @NotNull
                         @NotNull String delimiter)

_keySet

protected void _keySet(Map<String,Object> map,
                       Set<String> result,
                       String prefix)

_values

protected void _values(Map<String,Object> map,
                       Collection<Object> result)

_size

protected int _size(Map<String,Object> map)

_containsKey

protected boolean _containsKey(@NotNull
                               @NotNull String name)

_containsKey

protected boolean _containsKey(@NotNull
                               @NotNull String name,
                               @NotNull
                               @NotNull Map<String,Object> map,
                               @NotNull
                               @NotNull String delimiter)

_containsValue

protected boolean _containsValue(@NotNull
                                 @NotNull Object value)

_containsValue

protected boolean _containsValue(@NotNull
                                 @NotNull Object value,
                                 @NotNull
                                 @NotNull Map<String,Object> map)