yorkie/dev.yorkie.document.yson

Package-level declarations

Types

data class YsonTextNode(val value: String, val attrs: Map<String, YsonValue>? = null)

YsonTextNode represents a single character in a Text CRDT, optionally carrying inline attributes.

data class YsonTreeNode(val type: String, val value: String? = null, val attrs: Map<String, String>? = null, val children: List<YsonTreeNode>? = null)

YsonTreeNode represents a node in a Tree CRDT.

sealed interface YsonValue

YsonValue represents any valid YSON value.

Functions

fun isBinData(value: Any?): Boolean

isBinData returns true when value is a YsonValue.YsonBinData.

fun isCounter(value: Any?): Boolean

isCounter returns true when value is a YsonValue.YsonCounter.

fun isDate(value: Any?): Boolean

isDate returns true when value is a YsonValue.YsonDate.

fun isDedupCounter(value: Any?): Boolean

isDedupCounter returns true when value is a YsonValue.YsonDedupCounter.

fun isInt(value: Any?): Boolean

isInt returns true when value is a YsonValue.YsonInt.

fun isLong(value: Any?): Boolean

isLong returns true when value is a YsonValue.YsonLong.

fun isObject(value: Any?): Boolean

isObject returns true when value is a plain YsonValue.YsonObject, not a CRDT or special type.

fun isText(value: Any?): Boolean

isText returns true when value is a YsonValue.YsonText.

fun isTree(value: Any?): Boolean

isTree returns true when value is a YsonValue.YsonTree.

fun parse(yson: String): YsonValue

parse parses a YSON formatted string into a typed YsonValue.

inline fun <T : YsonValue> parseAs(yson: String): T

parseAs parses a YSON formatted string and narrows the result to T.

fun textToString(text: YsonValue.YsonText): String

textToString returns the concatenated character values of a YsonValue.YsonText.

fun treeToXML(tree: YsonValue.YsonTree): String

treeToXML returns an XML string representation of a YsonValue.YsonTree.