BSONDocument

Abstract Value Members

abstract def elements: Seq[BSONElement]

The document fields as a sequence of BSONElements.
abstract def headOption: Option[BSONElement]

The first/mandatory element, if any
abstract def isEmpty: Boolean

Indicates whether this document is empty

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from BSONDocument to any2stringadd[BSONDocument] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
final def ++(seq: BSONElement*): BSONDocument

Creates a new BSONDocument containing all the elements of this one and the specified element sequence.
final def ++(doc: BSONDocument): BSONDocument

Returns the BSONDocument containing all the elements of this one and the elements of the given document.
def ++(producers: ElementProducer*): BSONDocument

Creates a new BSONDocument containing all the elements of this one and the specified element producers.
Creates a new BSONDocument containing all the elements of this one and the specified element producers.

Definition Classes
BSONDocumentLowPriority
final def --(keys: String*): BSONDocument

Returns a set without the values corresponding to the specified keys.
def ->[B](y: B): (BSONDocument, B)

Implicit information
This member is added by an implicit conversion from BSONDocument to ArrowAssoc[BSONDocument] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
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 scala.util.Try
import reactivemongo.api.bson.BSONValue
def foo(v: BSONValue): Option[String] = v.asOpt[String]
```
Definition Classes
BSONValue
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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final val code: Byte

The code indicating the BSON type for this value
The code indicating the BSON type for this value

Definition Classes
BSONDocument → BSONValue
def contains(key: String): Boolean

Checks whether the given key is found in this element set.
Checks whether the given key is found in this element set.
key
the key to be found in the document
returns
true if the key is found
def ensuring(cond: (BSONDocument) ⇒ Boolean, msg: ⇒ Any): BSONDocument

Implicit information
This member is added by an implicit conversion from BSONDocument to Ensuring[BSONDocument] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (BSONDocument) ⇒ Boolean): BSONDocument

Implicit information
This member is added by an implicit conversion from BSONDocument to Ensuring[BSONDocument] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocument

Implicit information
This member is added by an implicit conversion from BSONDocument to Ensuring[BSONDocument] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): BSONDocument

Implicit information
This member is added by an implicit conversion from BSONDocument to Ensuring[BSONDocument] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Definition Classes
BSONDocument → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from BSONDocument to StringFormat[BSONDocument] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def get(key: String): Option[BSONValue]

Returns the BSONValue associated with the given key.
Returns the BSONValue associated with the given key. If the key cannot be found, returns None.
key
the key to be found in the document
final def getAsOpt[T](key: String)(implicit reader: BSONReader[T]): Option[T]

Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.
Returns the BSONValue associated with the given key, 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.
key
the key to be found in the document

Note
When implementing a custom reader, getAsTry must be preferred.
final def getAsTry[T](key: String)(implicit reader: BSONReader[T]): Try[T]

Gets the BSONValue associated with the given key, and converts it with the given implicit BSONReader.
Gets the BSONValue associated with the given key, 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 may hold a exceptions.BSONValueNotFoundException, if the key could not be found.
key
the key to be found in the document
final def getAsUnflattenedTry[T](key: String)(implicit reader: BSONReader[T]): Try[Option[T]]

Gets the BSONValue at the given key, and converts it with the given implicit BSONReader.
Gets the BSONValue at the given key, 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.
key
the key to be found in the document
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
BSONDocument → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def size: Int

The number of fields
The number of fields

Annotations
@inline()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toMap: Map[String, BSONValue]

Returns the map representation for this document.
Returns the map representation for this document.

Annotations
@inline()
def toString(): String

Definition Classes
BSONDocument → AnyRef → Any
final def values: Iterable[BSONValue]

Returns the values of the document fields.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (BSONDocument, B)

Implicit information
This member is added by an implicit conversion from BSONDocument to ArrowAssoc[BSONDocument] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from BSONDocumentLowPriority

Inherited from ElementProducer

Inherited from Producer[BSONElement]

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer from BSONDocument to Producer[BSONValue]

Inherited by implicit conversion valueProducer from BSONDocument to Producer[BSONValue]

Inherited by implicit conversion any2stringadd from BSONDocument to any2stringadd[BSONDocument]

Inherited by implicit conversion StringFormat from BSONDocument to StringFormat[BSONDocument]

Inherited by implicit conversion Ensuring from BSONDocument to Ensuring[BSONDocument]

Inherited by implicit conversion ArrowAssoc from BSONDocument to ArrowAssoc[BSONDocument]

Ungrouped

Related Docs: object BSONDocument | package bson

sealed abstract class BSONDocument extends BSONValue with ElementProducer with BSONDocumentLowPriority

Abstract Value Members

abstract def elements: Seq[BSONElement]

abstract def headOption: Option[BSONElement]

abstract def isEmpty: Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

final def ++(seq: BSONElement*): BSONDocument

final def ++(doc: BSONDocument): BSONDocument

def ++(producers: ElementProducer*): BSONDocument

final def --(keys: String*): BSONDocument

def ->[B](y: B): (BSONDocument, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def asOpt[T](implicit reader: BSONReader[T]): Option[T]

final def asTry[T](implicit reader: BSONReader[T]): Try[T]

def clone(): AnyRef

final val code: Byte

def contains(key: String): Boolean

def ensuring(cond: (BSONDocument) ⇒ Boolean, msg: ⇒ Any): BSONDocument

def ensuring(cond: (BSONDocument) ⇒ Boolean): BSONDocument

def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocument

def ensuring(cond: Boolean): BSONDocument

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def get(key: String): Option[BSONValue]

final def getAsOpt[T](key: String)(implicit reader: BSONReader[T]): Option[T]

final def getAsTry[T](key: String)(implicit reader: BSONReader[T]): Try[T]

final def getAsUnflattenedTry[T](key: String)(implicit reader: BSONReader[T]): Try[Option[T]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def size: Int

final def synchronized[T0](arg0: ⇒ T0): T0

final def toMap: Map[String, BSONValue]

def toString(): String

final def values: Iterable[BSONValue]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (BSONDocument, B)

Inherited from BSONDocumentLowPriority

Inherited from ElementProducer

Inherited from Producer[BSONElement]

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer from BSONDocument to Producer[BSONValue]

Inherited by implicit conversion valueProducer from BSONDocument to Producer[BSONValue]

Inherited by implicit conversion any2stringadd from BSONDocument to any2stringadd[BSONDocument]

Inherited by implicit conversion StringFormat from BSONDocument to StringFormat[BSONDocument]

Inherited by implicit conversion Ensuring from BSONDocument to Ensuring[BSONDocument]

Inherited by implicit conversion ArrowAssoc from BSONDocument to ArrowAssoc[BSONDocument]

Ungrouped