BSONArray

The BSON values

Returns a BSON array with the values of the given one appended.

import reactivemongo.api.bson.BSONArray

val arr1 = BSONArray(1, "foo")
val arr2 = BSONArray(2L, "bar")

arr1 ++ arr2 // [ 1, 'foo', NumberLong(2), 'bar' ]

Returns a BSON array with the given values appended.

import reactivemongo.api.bson.{ BSONArray, BSONLong }

val arr = BSONArray(1, "foo")

arr ++ BSONLong(3L) // [ 1, 'foo', NumberLong(3) ]

Returns a BSON array with the given value prepended.

import reactivemongo.api.bson.{ BSONArray, BSONString }

BSONString("foo") +: BSONArray(1L) // [ 'foo', NumberLong(1) ]

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

• It is reflexive: for any instance x of type Any, x.equals(x) should return true.
• It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Returns the BSONValue at the given index.

If there is no such index, None is returned.

def secondAsString(
 a: reactivemongo.api.bson.BSONArray): Option[String] =
 a.get(1).flatMap(_.asOpt[String])

Returns the BSONValue at the given index, and converts it with the given implicit BSONReader.

If there is no matching value, or the value could not be deserialized, or converted, returns a None.

import reactivemongo.api.bson.BSONArray

val arr = BSONArray(1, "foo")

arr.getAsOpt[Int](0) // Some(1)
arr.getAsOpt[Int](1) // None; "foo" not int

Gets the BSONValue at the given index, and converts it with the given implicit BSONReader.

If there is no matching value, or the value could not be deserialized, or converted, returns a Failure.

The Failure holds a exceptions.BSONValueNotFoundException if the index could not be found.

import reactivemongo.api.bson.BSONArray

val arr = BSONArray(1, "foo")

arr.getAsTry[Int](0) // Success(1)
arr.getAsTry[Int](1) // Failure(BSONValueNotFoundException(..))

Gets the BSONValue at the given index, and converts it with the given implicit BSONReader.

If there is no matching value, Success(None) is returned. If there is a value, it must be valid or a Failure is returned.

import reactivemongo.api.bson.BSONArray

val arr = BSONArray(1, "foo")

arr.getAsUnflattenedTry[Int](0) // Success(Some(1))
arr.getAsUnflattenedTry[Int](1) // Failure(BSONValueNotFoundException(..))
arr.getAsUnflattenedTry[Int](2) // Success(None) // no value at 2

Returns the BSONValue at the given index, and converts it with the given implicit BSONReader.

If there is no matching value, or the value could not be deserialized, or converted, returns the default value.

import reactivemongo.api.bson.BSONArray

val arr = BSONArray(1, "foo")

arr.getOrElse[Int](0, -1) // 1
arr.getOrElse[Int](1, -1) // -1; "foo" not int

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

The first/mandatory value, if any

Indicates whether this array is empty

The number of values

Returns a string representation of the object.

The default representation is platform dependent.

Optionally parses this value as a T one.

Tries to parse this value as a T one.

import scala.util.Try
import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Try[String] = v.asTry[String]

The code indicating the BSON type for this value as Byte

The code indicating the BSON type for this value