org.springframework.data.mongodb.util

Class BsonUtils

java.lang.Object

org.springframework.data.mongodb.util.BsonUtils

public class BsonUtils
extends Object

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
BsonUtils()

Method Summary

Modifier and Type	Method and Description
static void	addToMap(org.bson.conversions.Bson bson, String key, Object value)
static Map<String,Object>	asMap(org.bson.conversions.Bson bson)
static <T> T	get(org.bson.conversions.Bson bson, String key)
static boolean	isJsonArray(String value) Check if a given String looks like parsable json array.
static boolean	isJsonDocument(String value) Check if a given String looks like parsable json.
static org.bson.Document	merge(org.bson.Document... documents) Merge the given documents into on in the given order.
static org.bson.Document	parse(String json, CodecRegistryProvider codecRegistryProvider) Parse the given json to Document applying transformations as specified by a potentially given Codec.
static org.bson.BsonValue	simpleToBsonValue(Object source) Convert a given simple value (eg.
static org.bson.Document	toDocumentOrElse(String source, Function<String,org.bson.Document> orElse)
static Object	toJavaType(org.bson.BsonValue value) Extract the corresponding plain value from BsonValue.
static String	toJson(org.bson.Document source) Serialize the given Document as Json applying default codecs if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

BsonUtils

public BsonUtils()

Method Detail

get

@Nullable
public static <T> T get(org.bson.conversions.Bson bson,
                                  String key)

asMap

public static Map<String,Object> asMap(org.bson.conversions.Bson bson)

addToMap

public static void addToMap(org.bson.conversions.Bson bson,
                            String key,
                            @Nullable
                            Object value)

toJavaType

public static Object toJavaType(org.bson.BsonValue value)

Extract the corresponding plain value from BsonValue. Eg. plain String from BsonString.

Parameters:

value - must not be null.

Returns:

Since:

2.1

simpleToBsonValue

public static org.bson.BsonValue simpleToBsonValue(Object source)

Convert a given simple value (eg. String, Long) to its corresponding BsonValue.

Parameters:

source - must not be null.

Returns:

the corresponding BsonValue representation.

Throws:

IllegalArgumentException - if source does not correspond to a BsonValue type.

Since:

3.0

merge

public static org.bson.Document merge(org.bson.Document... documents)

Merge the given documents into on in the given order. Keys contained within multiple documents are overwritten by their follow ups.

Parameters:

documents - must not be null. Can be empty.

Returns:

the document containing all key value pairs.

Since:

2.2

toDocumentOrElse

public static org.bson.Document toDocumentOrElse(String source,
                                                 Function<String,org.bson.Document> orElse)

Parameters:

source -

orElse -

Returns:

Since:

2.2

toJson

@Nullable
public static String toJson(@Nullable
                                      org.bson.Document source)

Serialize the given Document as Json applying default codecs if necessary.

Parameters:

source -

Returns:

Since:

2.2.1

isJsonDocument

public static boolean isJsonDocument(@Nullable
                                     String value)

Check if a given String looks like parsable json.

Parameters:

value - can be null.

Returns:

true if the given value looks like a json document.

Since:

3.0

isJsonArray

public static boolean isJsonArray(@Nullable
                                  String value)

Check if a given String looks like parsable json array.

Parameters:

value - can be null.

Returns:

true if the given value looks like a json array.

Since:

3.0

parse

public static org.bson.Document parse(String json,
                                      @Nullable
                                      CodecRegistryProvider codecRegistryProvider)

Parse the given json to Document applying transformations as specified by a potentially given Codec.

Parameters:

json - must not be null.

codecRegistryProvider - can be null. In that case the default DocumentCodec is used.

Returns:

never null.

Throws:

IllegalArgumentException - if the required argument is null.

Since:

3.0