Package com.mongodb.client.model.mql

Interface MqlMap<T extends MqlValue>

Type Parameters:

T - the type of the entry values

All Superinterfaces:

MqlValue

@Sealed
@Beta(CLIENT)
public interface MqlMap<T extends MqlValue>
extends MqlValue

A map value in the context of the MongoDB Query Language (MQL). A map is a finite set of entries of a certain type. No entry key is repeated. It is a mapping from keys to values.

Since:

4.9.0

Method Summary

Modifier and Type	Method	Description
<R extends MqlDocument> R	asDocument()	this map as a document.
MqlArray<MqlEntry<T>>	entries()	The entries of this map as an array.
T	get(MqlString key)	The value corresponding to the provided key.
T	get(MqlString key, T other)	The value corresponding to the provided key, or the other value if an entry for the key is not present.
default T	get(String key)	The value corresponding to the provided key.
default T	get(String key, T other)	The value corresponding to the provided key, or the other value if an entry for the key is not present.
MqlBoolean	has(MqlString key)	Whether this map has a value (including null) for the provided key.
default MqlBoolean	has(String key)	Whether this map has a value (including null) for the provided key.
MqlMap<T>	merge(MqlMap<? extends T> other)	Returns a map with the same entries as this map, but with any keys present in the other map overwritten with the values of that other map.
<R extends MqlValue> R	passMapTo(Function<? super MqlMap<T>,? extends R> f)	The result of passing this value to the provided function.
MqlMap<T>	set(MqlString key, T value)	Returns a map with the same entries as this map, but with the specified key set to the specified value.
default MqlMap<T>	set(String key, T value)	Returns a map with the same entries as this map, but with the specified key set to the specified value.
<R extends MqlValue> R	switchMapOn(Function<Branches<MqlMap<T>>,? extends BranchesTerminal<MqlMap<T>,? extends R>> mapping)	The result of applying the provided switch mapping to this value.
MqlMap<T>	unset(MqlString key)	Returns a map with the same entries as this map, but which has no entry with the specified key.
default MqlMap<T>	unset(String key)	Returns a map with the same entries as this map, but which has no entry with the specified key.

Methods inherited from interface com.mongodb.client.model.mql.MqlValue

asString, eq, equals, gt, gte, isArrayOr, isBooleanOr, isDateOr, isDocumentOr, isIntegerOr, isMapOr, isNumberOr, isStringOr, lt, lte, ne, passTo, switchOn

Method Details

has

MqlBoolean has(MqlString key)

Whether this map has a value (including null) for the provided key.

Parameters:

key - the key.

Returns:

the resulting value.

has

default MqlBoolean has(String key)

Whether this map has a value (including null) for the provided key.

Parameters:

key - the key.

Returns:

the resulting value.

get

@MqlUnchecked(PRESENT)
T get(MqlString key)

The value corresponding to the provided key.

Warning: The use of this method is an unchecked assertion that the key is present (which may be confirmed via has(com.mongodb.client.model.mql.MqlString)). See get(MqlString, MqlValue) for a typesafe variant.

Parameters:

key - the key.

Returns:

the value.

get

@MqlUnchecked(PRESENT)
default T get(String key)

The value corresponding to the provided key.

Warning: The use of this method is an unchecked assertion that the key is present (which may be confirmed via has(com.mongodb.client.model.mql.MqlString)). See get(MqlString, MqlValue) for a typesafe variant.

Parameters:

key - the key.

Returns:

the value.

get

T get(MqlString key,
 T other)

The value corresponding to the provided key, or the other value if an entry for the key is not present.

Parameters:

key - the key.

other - the other value.

Returns:

the resulting value.

get

default T get(String key,
 T other)

The value corresponding to the provided key, or the other value if an entry for the key is not present.

Parameters:

key - the key.

other - the other value.

Returns:

the resulting value.

set

MqlMap<T> set(MqlString key,
 T value)

Returns a map with the same entries as this map, but with the specified key set to the specified value.

This does not affect the original map.

Parameters:

key - the key.

value - the value.

Returns:

the resulting value.

set

default MqlMap<T> set(String key,
 T value)

Returns a map with the same entries as this map, but with the specified key set to the specified value.

This does not affect the original map.

Parameters:

key - the key.

value - the value.

Returns:

the resulting value.

unset

MqlMap<T> unset(MqlString key)

Returns a map with the same entries as this map, but which has no entry with the specified key.

This does not affect the original map.

Parameters:

key - the key.

Returns:

the resulting value.

unset

default MqlMap<T> unset(String key)

Returns a map with the same entries as this map, but which has no entry with the specified key.

This does not affect the original map.

Parameters:

key - the key.

Returns:

the resulting value.

merge

MqlMap<T> merge(MqlMap<? extends T> other)

Returns a map with the same entries as this map, but with any keys present in the other map overwritten with the values of that other map. That is, entries from both this and the other map are merged, with the other map having priority.

This does not affect the original map.

Parameters:

other - the other map.

Returns:

the resulting value.

entries

MqlArray<MqlEntry<T>> entries()

The entries of this map as an array. No guarantee is made regarding order.

Returns:

the resulting value.

See Also:

• MqlArray.asMap(java.util.function.Function<? super T, ? extends com.mongodb.client.model.mql.MqlEntry<? extends R>>)

asDocument

<R extends MqlDocument> R asDocument()

this map as a document.

Type Parameters:

R - the resulting type.

Returns:

the resulting value.

passMapTo

<R extends MqlValue> R passMapTo(Function<? super MqlMap<T>,? extends R> f)

The result of passing this value to the provided function. Equivalent to f.apply(this), and allows lambdas and static, user-defined functions to use the chaining syntax.

Type Parameters:

R - the type of the resulting value.

Parameters:

f - the function to apply.

Returns:

the resulting value.

See Also:

• MqlValue.passTo(java.util.function.Function<? super com.mongodb.client.model.mql.MqlValue, ? extends R>)

switchMapOn

<R extends MqlValue> R switchMapOn(Function<Branches<MqlMap<T>>,? extends BranchesTerminal<MqlMap<T>,? extends R>> mapping)

The result of applying the provided switch mapping to this value.

Type Parameters:

R - the type of the resulting value.

Parameters:

mapping - the switch mapping.

Returns:

the resulting value.

See Also:

• MqlValue.switchOn(java.util.function.Function<com.mongodb.client.model.mql.Branches<com.mongodb.client.model.mql.MqlValue>, ? extends com.mongodb.client.model.mql.BranchesTerminal<com.mongodb.client.model.mql.MqlValue, ? extends R>>)