Packages

sealed abstract class BSONArray extends BSONValue

A BSONArray (type 0x04) is a indexed sequence of BSONValue.

import reactivemongo.api.bson._

BSONArray(BSONString("foo"), BSONDouble(1.2D))
Linear Supertypes
BSONValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONArray
  2. BSONValue
  3. AnyRef
  4. Any
Implicitly
  1. by identityValueProducer
  2. by valueProducer
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def values: IndexedSeq[BSONValue]

    The BSON values

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BSONArray toany2stringadd[BSONArray] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ++(values: BSONValue*): BSONArray

    Returns a BSON array with the given values appended.

    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) ]
  5. def ++(arr: BSONArray): BSONArray

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

    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' ]
  6. def +:(value: BSONValue): BSONArray

    Returns a BSON array with the given value prepended.

    Returns a BSON array with the given value prepended.

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

BSONString("foo") +: BSONArray(1L) // [ 'foo', NumberLong(1) ]
  7. def ->[B](y: B): (BSONArray, B)
    Implicit
    This member is added by an implicit conversion from BSONArray toArrowAssoc[BSONArray] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def asOpt[T](implicit reader: BSONReader[T]): Option[T]

    Optionally parses this value as a T one.

    Optionally parses this value as a T one.

    returns

    Some successfully parsed value, or None if fails

    import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Option[String] = v.asOpt[String]
    Definition Classes
    BSONValue
    Annotations
    @inline()
  11. final def asTry[T](implicit reader: BSONReader[T]): Try[T]

    Tries to parse 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]
    Definition Classes
    BSONValue
  12. val bsonType: String

    The pretty type name

    The pretty type name

    Definition Classes
    BSONArray → BSONValue
  13. val byteCode: Byte

    The code indicating the BSON type for this value as Byte

    The code indicating the BSON type for this value as Byte

    Definition Classes
    BSONArray → BSONValue
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. val code: Int

    The code indicating the BSON type for this value

    The code indicating the BSON type for this value

    Definition Classes
    BSONArray → BSONValue
  16. def ensuring(cond: (BSONArray) => Boolean, msg: => Any): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (BSONArray) => Boolean): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(that: Any): Boolean
    Definition Classes
    BSONArray → AnyRef → Any
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  23. def get(index: Int): Option[BSONValue]

    Returns the BSONValue at the given index.

    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])
    index

    the index to be found in the array (0 being the first)

  24. def getAsOpt[T](index: Int)(implicit reader: BSONReader[T]): Option[T]

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

    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
    index

    the index to be found in the array (0 being the first)

  25. def getAsTry[T](index: Int)(implicit reader: BSONReader[T]): Try[T]

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

    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(..))
    index

    the index to be found in the array (0 being the first)

  26. def getAsUnflattenedTry[T](index: Int)(implicit reader: BSONReader[T]): Try[Option[T]]

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

    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
    index

    the index to be found in the array (0 being the first)

  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def getOrElse[T](index: Int, default: => T)(implicit reader: BSONReader[T]): T

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

    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
    index

    the index to be found in the array (0 being the first)

  29. def hashCode(): Int
    Definition Classes
    BSONArray → AnyRef → Any
  30. def headOption: Option[BSONValue]

    The first/mandatory value, if any

  31. def isEmpty: Boolean

    Indicates whether this array is empty

    Indicates whether this array is empty

    Annotations
    @inline()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. def size: Int

    The number of values

    The number of values

    Annotations
    @inline()
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    BSONArray → AnyRef → Any
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONArray toStringFormat[BSONArray] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (BSONArray, B)
    Implicit
    This member is added by an implicit conversion from BSONArray toArrowAssoc[BSONArray] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer fromBSONArray to Producer[BSONValue]

Inherited by implicit conversion valueProducer fromBSONArray to Producer[BSONValue]

Inherited by implicit conversion any2stringadd fromBSONArray to any2stringadd[BSONArray]

Inherited by implicit conversion StringFormat fromBSONArray to StringFormat[BSONArray]

Inherited by implicit conversion Ensuring fromBSONArray to Ensuring[BSONArray]

Inherited by implicit conversion ArrowAssoc fromBSONArray to ArrowAssoc[BSONArray]

Ungrouped