クラス BsonUtils

方法の詳細

• get

  @Contract("null, _ -> null") public static <T> @Nullable T get(@Nullable org.bson.conversions.Bson bson, StringSE key)

• asMap

  public static MapSE<StringSE,ObjectSE> asMap(@Nullable org.bson.conversions.Bson bson)

  Bson オブジェクトを MapSE として返します。入力型に応じて、戻り値は bson のキャストバージョンか、変換された値 (元の値から切り離されたもの) のいずれかになります。

  パラメーター:

  bson -

  戻り値:

• asMap

  public static MapSE<StringSE,ObjectSE> asMap(@Nullable org.bson.conversions.Bson bson, org.bson.codecs.configuration.CodecRegistry codecRegistry)

  Bson オブジェクトを MapSE として返します。入力型に応じて、戻り値は bson のキャストバージョンか、指定された CodecRegistry を使用して変換に必要な可能性のある codecs を取得して変換された (元の値から切り離された) バージョンのいずれかになります。

  パラメーター:

  bson - null でもかまいません。

  codecRegistry - null であってはなりません。

  戻り値:

  決して null にはなりません。入力 Bson が null の場合は空の MapSE を返します。

  導入:

  4.0

• asDocument

  public static org.bson.Document asDocument(@Nullable org.bson.conversions.Bson bson)

  Bson オブジェクトを Document として返します。入力型に応じて、戻り値は bson のキャストバージョンか、変換された値 (元の値から切り離されたもの) のいずれかになります。

  パラメーター:

  bson -

  戻り値:

  導入:

  3.2.5

• asDocument

  public static org.bson.Document asDocument(@Nullable org.bson.conversions.Bson bson, org.bson.codecs.configuration.CodecRegistry codecRegistry)

  Bson オブジェクトを Document として返します。入力型に応じて、戻り値は bson のキャストバージョンか、指定された CodecRegistry を使用して変換に必要な可能性のある codecs を取得して変換された (元の値から切り離された) バージョンのいずれかになります。

  パラメーター:

  bson -

  codecRegistry - null であってはなりません。

  戻り値:

  決して null にはなりません。

  導入:

  4.0

• asMutableDocument

  public static org.bson.Document asMutableDocument(org.bson.conversions.Bson bson)

  Bson のすべてのエントリを含む変更可能な Document として Bson オブジェクトを返します。

  パラメーター:

  bson -

  戻り値:

  Bson のすべてのエントリを含む変更可能な Document。

  導入:

  3.2.5

• addToMap

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

• addAllToMap

  public static void addAllToMap(org.bson.conversions.Bson target, MapSE<StringSE,?> source)

  指定されたソース MapSE からのすべてのエントリをターゲットに追加します。

  パラメーター:

  target - null であってはなりません。

  source - null であってはなりません。

  導入:

  3.2

• contains

  public static boolean contains(org.bson.conversions.Bson bson, StringSE key, @Nullable ObjectSE value)

  指定されたエントリ (キー / 値のペア) が指定された Bson に存在するかどうかを確認します。

  パラメーター:

  bson - null であってはなりません。

  key - null であってはなりません。

  value - null でもかまいません。

  戻り値:

  (キー / 値のペア) が存在する場合は true。

  導入:

  3.2

• removeNullId

  public static boolean removeNullId(org.bson.conversions.Bson bson)

  指定された Bson から _id : null を削除します (存在する場合)。

  パラメーター:

  bson - null であってはなりません。

  導入:

  3.2

• toJavaType

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

  BsonValue から対応するプレーン値を抽出します。例: BsonString からプレーン StringSE を抽出します。

  パラメーター:

  value - null であってはなりません。

  戻り値:

  導入:

  2.1

• simpleToBsonValue

  public static org.bson.BsonValue simpleToBsonValue(@Nullable ObjectSE source)

  指定された単純な値 (例: StringSE、LongSE ) を対応する BsonValue に変換します。

  パラメーター:

  source - null であってはなりません。

  戻り値:

  対応する BsonValue 表現。

  例外:

  IllegalArgumentExceptionSE - ソースが BsonValue 型に対応していない場合。

  導入:

  3.0

• simpleToBsonValue

  @Contract("null, _ -> !null") public static org.bson.BsonValue simpleToBsonValue(@Nullable ObjectSE source, org.bson.codecs.configuration.CodecRegistry codecRegistry)

  指定された単純な値 (例: StringSE、LongSE ) を対応する BsonValue に変換します。

  パラメーター:

  source - null でもかまいません。

  codecRegistry - ネイティブ Codec を使用して型を変換するためのフォールバックとして使用される CodecRegistry。null にすることはできません。

  戻り値:

  対応する BsonValue 表現。

  例外:

  IllegalArgumentExceptionSE - ソースが BsonValue 型に対応していない場合。

  導入:

  4.2

• merge

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

  指定された documents を指定された順序で 1 つにマージします。複数のドキュメント内に含まれるキーは、後続のキーによって上書きされます。

  パラメーター:

  documents - null であってはなりません。空であっても構いません。

  戻り値:

  すべてのキーと値のペアを含むドキュメント。

  導入:

  2.2

• toDocumentOrElse

  public static org.bson.Document toDocumentOrElse(StringSE source, FunctionSE<StringSE, org.bson.Document> orElse)

  パラメーター:

  source -

  orElse -

  戻り値:

  導入:

  2.2

• toJson

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

  必要に応じてデフォルトのコーデックを適用し、指定された Document を Json として直列化します。

  パラメーター:

  source -

  戻り値:

  導入:

  2.2.1

• isJsonDocument

  @Contract("null -> false") public static boolean isJsonDocument(@Nullable StringSE value)

  指定された文字列が parsable json に似ているかどうかを確認します。

  パラメーター:

  value - null でもかまいません。

  戻り値:

  指定された値が JSON ドキュメントのように見える場合は true。

  導入:

  3.0

• isJsonArray

  @Contract("null -> false") public static boolean isJsonArray(@Nullable StringSE value)

  指定された文字列が parsable json 配列に似ているかどうかを確認します。

  パラメーター:

  value - null でもかまいません。

  戻り値:

  指定された値が json 配列のように見える場合は true です。

  導入:

  3.0

• parse

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

  指定された json を、指定された Codec によって指定された変換を適用して Document に解析します。

  パラメーター:

  json - null であってはなりません。

  codecRegistryProvider - null にすることもできます。その場合はデフォルトの DocumentCodec が使用されます。

  戻り値:

  決して null にはなりません。

  例外:

  IllegalArgumentExceptionSE - 必要な引数が null の場合。

  導入:

  3.0

• resolveValue

  public static @Nullable ObjectSE resolveValue(org.bson.conversions.Bson bson, StringSE key)

  指定されたキーの値を解決します。指定された Bson 値にキーが含まれている場合は、その値がすぐに返されます。キーにドット (.) 表記を使用したパスが含まれている場合は、個々の部分をインスペクションしてパスを解決しようとします。中間の 1 つが null であるか、それ以上インスペクションできない (間違った) 型の場合は、null が返されます。

  パラメーター:

  bson - インスペクションするソース。null にすることはできません。

  key - 検索するキー。null にすることはできません。

  戻り値:

  null でもかまいません。

  導入:

  3.0.8

• resolveValue

  public static @Nullable ObjectSE resolveValue(org.bson.conversions.Bson bson, FieldName fieldName)

  指定された field name の値を解決します。指定された名前が FieldName.Type.KEY の場合、値はターゲット Bson からすぐに取得されます。指定された fieldName が FieldName.Type.PATH の場合 (ドット (.) 表記を使用している可能性があります)、個々の部分をインスペクションしてパスを解決しようとします。中間の 1 つが null であるか、それ以上インスペクションできない (間違った) 型の場合は、null が返されます。

  パラメーター:

  bson - インスペクションするソース。null にすることはできません。

  fieldName - 検索する名前。null にすることはできません。

  戻り値:

  null でもかまいません。

  導入:

  4.2

• resolveValue

  public static @Nullable ObjectSE resolveValue(MapSE<StringSE,ObjectSE> source, FieldName fieldName)

  指定された field name の値を解決します。指定された名前が FieldName.Type.KEY の場合、値はターゲット Bson からすぐに取得されます。指定された fieldName が FieldName.Type.PATH の場合 (ドット (.) 表記を使用している可能性があります)、個々の部分をインスペクションしてパスを解決しようとします。中間の 1 つが null であるか、それ以上インスペクションできない (間違った) 型の場合は、null が返されます。

  パラメーター:

  source - インスペクションするソース。null にすることはできません。

  fieldName - 検索するキー。null にすることはできません。

  戻り値:

  null でもかまいません。

  導入:

  4.2

• resolveValue

  public static @Nullable ObjectSE resolveValue(MapSE<StringSE,ObjectSE> source, StringSE key)

  指定されたキーの値を解決します。指定された MapSE 値にキーが含まれている場合は、その値がすぐに返されます。キーにドット (.) 表記を使用したパスが含まれている場合は、個々の部分をインスペクションしてパスを解決しようとします。中間の 1 つが null であるか、それ以上インスペクションできない (間違った) 型の場合は、null が返されます。

  パラメーター:

  source - インスペクションするソース。null にすることはできません。

  key - 検索するキー。null にすることはできません。

  戻り値:

  null でもかまいません。

  導入:

  4.1

• hasValue

  public static boolean hasValue(org.bson.conversions.Bson bson, FieldName fieldName)

• hasValue

  public static boolean hasValue(org.bson.conversions.Bson bson, StringSE key)

  指定された key に対して、基になる bson に値 (null または非 null) があるかどうかを返します。

  パラメーター:

  bson - インスペクションするソース。null にすることはできません。

  key - 検索するキー。null にすることはできません。

  戻り値:

  null 以外の値が存在しない場合は true。

  導入:

  3.0.8

• asBson

  public static org.bson.conversions.Bson asBson(ObjectSE source)

  指定されたソースオブジェクトを Bson として返します。つまり、Document として返され、そのままマップされるか、IllegalArgumentExceptionSE がスローされます。

  パラメーター:

  source -

  戻り値:

  変換 / キャストされたソースオブジェクト。

  例外:

  IllegalArgumentExceptionSE - source を Bson に変換 / キャストできない場合。

  導入:

  3.2.3

  関連事項:

  • supportsBson(Object)

• supportsBson

  public static boolean supportsBson(ObjectSE source)

  指定されたソースを Bson として使用 / 変換できるかどうかを返します。

  パラメーター:

  source -

  戻り値:

  指定されたソースを Bson に変換できる場合は true。

  導入:

  3.2.3

• asCollection

  public static CollectionSE<?> asCollection(ObjectSE source)

  指定されたオブジェクトを CollectionSE として返します。ソースがすでに CollectionSE である場合は CollectionSE をそのまま返し、配列を CollectionSE に変換するか、それ以外の場合は単に単一要素のコレクションを作成します。

  パラメーター:

  source - null であってはなりません。

  戻り値:

  決して null にはなりません。

  導入:

  3.2

• mapValues

  public static org.bson.Document mapValues(org.bson.Document source, BiFunctionSE<StringSE,ObjectSE,ObjectSE> valueMapper)

• mapEntries

  public static org.bson.Document mapEntries(org.bson.Document source, FunctionSE<Map.EntrySE<StringSE,ObjectSE>, StringSE> keyMapper, FunctionSE<Map.EntrySE<StringSE,ObjectSE>, ObjectSE> valueMapper)