SortOption¶

class SortOption<Document : Any>(config: SortOptionDsl<Document>, context: BsonContext) : AbstractCompoundOption

Describes in which order elements should be returned.

For more information, see WithSort.sort.

Constructors¶

constructor(config: SortOptionDsl<Document>, context: BsonContext)

val block: ERROR CLASS: Symbol not found for Bson

The sort option's configured block.

open override val context: BsonContext

The context used to generate this expression.

open override val name: String

The name of this option, as it appears in the BSON representation.

open override fun freeze()

Makes this node immutable.

override fun read(): ERROR CLASS: Symbol not found for BsonValueReader

Reads the value of this option.

override fun simplify(): AbstractBsonNode?

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

open fun toBson(): ERROR CLASS: Symbol not found for Bson

Writes the result of simplifying to a new Bson.

override fun toString(): String

JSON representation of this expression.

fun toString(simplified: Boolean): String

JSON representation of this expression.

override fun writeTo(writer: ERROR CLASS: Symbol not found for BsonFieldWriter)

Writes the result of simplifying this expression into writer.