KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.tree/CompoundBsonNode

CompoundBsonNode

interface CompoundBsonNode : BsonNode, CompoundNode<BsonNode> (source)

A compound expression is an BsonNode that may have children.

A compound expression may have 0..n children. Children are added by calling the accept function.

This is also the supertype for all DSL scopes, since DSL scopes correspond to the ability to add children to an expression.

Implementation notes

Prefer implementing AbstractCompoundBsonNode instead of implementing this interface directly.

Inheritors

ValueAccumulators

ProjectStageOperators

UpdateWithPipelineQuery

AbstractCompoundBsonNode

Types

Companion

object Companion

Properties

context

@LowLevelApi

abstract val context: BsonContext

The context used to generate this expression.

Functions

@LowLevelApi

@DangerousMongoApi

abstract override fun accept(node: BsonNode)

Adds a new node as a child of this one.

acceptAll

@LowLevelApi

@DangerousMongoApi

fun <N : Node> CompoundNode<N>.acceptAll(nodes: Iterable<N>)

Adds any number of nodes into this one.

freeze

@LowLevelApi

abstract override fun freeze()

Makes this expression immutable.

simplify

@LowLevelApi

abstract fun simplify(): BsonNode?

Returns a simplified (but equivalent) expression to the current expression.

toBson

@LowLevelApi

open fun toBson(): Bson

Writes the result of simplifying to a new BSON document.

toString

abstract override fun toString(): String

JSON representation of this expression.

writeTo

@LowLevelApi

abstract override fun writeTo(writer: BsonFieldWriter)

Writes the result of simplifying this expression into writer.