Package org.apache.juneau.marshall.collections

Class ResolvingMarshalledMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.apache.juneau.marshall.collections.MarshalledMap

org.apache.juneau.marshall.collections.ResolvingMarshalledMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class ResolvingMarshalledMap
extends MarshalledMap

Subclass of a MarshalledMap that automatically resolves any SVL variables in values.

Resolves variables in the following values:

• Values of type CharSequence.
• Arrays containing values of type CharSequence.
• Collections containing values of type CharSequence.
• Maps containing values of type CharSequence.

All other data types are left as-is.

See Also:

• Marshall Simple Variable Language

See Also:

• Serialized Form

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Field Summary

Fields inherited from class org.apache.juneau.marshall.collections.MarshalledMap

EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
ResolvingMarshalledMap(VarResolverSession varResolver)	Constructor.

Method Summary

Modifier and Type	Method	Description
ResolvingMarshalledMap	append(String key, Object value)	Adds an entry to this map.
ResolvingMarshalledMap	append(Map<String,Object> values)	Appends all the entries in the specified map to this map.
ResolvingMarshalledMap	appendIf(boolean flag, String key, Object value)	Add if flag is true.
boolean	equals(Object o)
ResolvingMarshalledMap	filtered(Predicate<Object> value)	Enables filtering based on a predicate test.
Object	get(Object key)
int	hashCode()
ResolvingMarshalledMap	inner(Map<String,Object> inner)	Set an inner map in this map to allow for chained get calls.
ResolvingMarshalledMap	keepAll(String... keys)	The opposite of MarshalledMap.removeAll(String...).
ResolvingMarshalledMap	modifiable()	Returns a modifiable copy of this map if it's unmodifiable.
ResolvingMarshalledMap	session(MarshallingSession session)	Override the default bean session used for converting POJOs.
ResolvingMarshalledMap	setBeanSession(MarshallingSession value)	Sets the MarshallingSession currently associated with this map.
ResolvingMarshalledMap	unmodifiable()	Returns an unmodifiable copy of this map if it's modifiable.

Methods inherited from class org.apache.juneau.marshall.collections.MarshalledMap

appendFirst, appendIf, appendIfAbsent, appendIfAbsentIf, at, bs, cast, cast, containsKey, containsKeyNotEmpty, containsOuterKey, create, deleteAt, entrySet, exclude, filtered, filteredMap, filteredMap, find, find, findBoolean, findInt, findKeyIgnoreCase, findList, findLong, findMap, findString, get, get, getAt, getAt, getBoolean, getBoolean, getClassMeta, getFirstKey, getInt, getInt, getList, getList, getList, getList, getLong, getLong, getMap, getMap, getMap, getMap, getMarshallingSession, getString, getString, getStringArray, getStringArray, getSwapped, getWithDefault, getWithDefault, getWithDefault, include, is, isUnmodifiable, keySet, newMarshalledMap, of, of, ofString, ofString, postAt, put, putAt, removeAll, removeAll, removeBoolean, removeBoolean, removeInt, removeInt, removeString, removeString, removeWithDefault, toString

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, forEach, getOrDefault, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Details

ResolvingMarshalledMap

public ResolvingMarshalledMap(VarResolverSession varResolver)

Constructor.

Parameters:

varResolver - The var resolver session to use for resolving SVL variables.

Method Details

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class MarshalledMap

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class MarshalledMap

append

public ResolvingMarshalledMap append(Map<String,Object> values)

Description copied from class: MarshalledMap

Appends all the entries in the specified map to this map.

Overrides:

append in class MarshalledMap

Parameters:

values - The map to copy. Can be null (no-op).

Returns:

This object.

append

public ResolvingMarshalledMap append(String key,
 Object value)

Description copied from class: MarshalledMap

Adds an entry to this map.

Overrides:

append in class MarshalledMap

Parameters:

key - The key.

value - The value.

Returns:

This object.

appendIf

public ResolvingMarshalledMap appendIf(boolean flag,
 String key,
 Object value)

Description copied from class: MarshalledMap

Add if flag is true.

Overrides:

appendIf in class MarshalledMap

Parameters:

flag - The flag to check.

key - The key.

value - The value.

Returns:

This object.

filtered

public ResolvingMarshalledMap filtered(Predicate<Object> value)

Description copied from class: MarshalledMap

Enables filtering based on a predicate test.

If the predicate evaluates to false on values added to this map, the entry will be skipped.

Overrides:

filtered in class MarshalledMap

Parameters:

value - The value tester predicate.

Returns:

This object.

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class MarshalledMap

inner

public ResolvingMarshalledMap inner(Map<String,Object> inner)

Description copied from class: MarshalledMap

Set an inner map in this map to allow for chained get calls.

If MarshalledMap.get(Object) returns null, then MarshalledMap.get(Object) will be called on the inner map.

Overrides:

inner in class MarshalledMap

Parameters:

inner - The inner map. Can be null to remove the inner map from an existing map.

Returns:

This object.

keepAll

public ResolvingMarshalledMap keepAll(String... keys)

Description copied from class: MarshalledMap

The opposite of MarshalledMap.removeAll(String...).

Discards all keys from this map that aren't in the specified list.

Overrides:

keepAll in class MarshalledMap

Parameters:

keys - The keys to keep.

Returns:

This map.

modifiable

public ResolvingMarshalledMap modifiable()

Description copied from class: MarshalledMap

Returns a modifiable copy of this map if it's unmodifiable.

Overrides:

modifiable in class MarshalledMap

Returns:

A modifiable copy of this map if it's unmodifiable, or this map if it is already modifiable.

session

public ResolvingMarshalledMap session(MarshallingSession session)

Description copied from class: MarshalledMap

Override the default bean session used for converting POJOs.

Default is MarshallingContext.DEFAULT, which is sufficient in most cases.

Useful if you're serializing/parsing beans with transforms defined.

Overrides:

session in class MarshalledMap

Parameters:

session - The new bean session.

Returns:

This object.

setBeanSession

public ResolvingMarshalledMap setBeanSession(MarshallingSession value)

Description copied from class: MarshalledMap

Sets the MarshallingSession currently associated with this map.

Overrides:

setBeanSession in class MarshalledMap

Parameters:

value - The MarshallingSession currently associated with this map.

Returns:

This object.

unmodifiable

public ResolvingMarshalledMap unmodifiable()

Description copied from class: MarshalledMap

Returns an unmodifiable copy of this map if it's modifiable.

Overrides:

unmodifiable in class MarshalledMap

Returns:

An unmodifiable copy of this map if it's modifiable, or this map if it is already unmodifiable.