kpointer-yamlkt/com.commonsware.kpointer.yamlkt/YamlPrimitiveAdapter

YamlPrimitiveAdapter

class YamlPrimitiveAdapter(val backing: YamlPrimitive) : YamlElementAdapter, KpaPrimitive(source)

Adapter exposing a YamlPrimitive (including YamlNull) as a KpaPrimitive.

Primitive typing follows the YAML 1.2 core schema:

isBoolean is true only for literals whose content is one of true, True, TRUE, false, False, FALSE.
isNumber is true for literals whose content parses via String.toLongOrNull or String.toDoubleOrNull and is not already classified as a boolean.
isString is true for any non-boolean, non-numeric YamlLiteral.

Parameters

backing

The underlying YamlPrimitive.

Constructors

YamlPrimitiveAdapter

constructor(backing: YamlPrimitive)

Properties

open override val backing: YamlPrimitive

open override val booleanOrNull: Boolean?

true/false parsed from the matching YAML 1.2 boolean literal; null if isBoolean is false.

open override val doubleOrNull: Double?

The literal content parsed as Double if isNumber; null otherwise.

open override val isBoolean: Boolean

true if backing is a YamlLiteral whose content matches a YAML 1.2 boolean literal.

open override val isNull: Boolean

true if backing is YamlNull.

open override val isNumber: Boolean

true if backing is a non-boolean YamlLiteral whose content parses as Long or Double.

open override val isString: Boolean

true if backing is a YamlLiteral whose content is not a YAML 1.2 boolean or number.

open override val longOrNull: Long?

The literal content parsed as Long if isNumber and the content has no fractional part; null otherwise.

open override val stringOrNull: String?

The literal content if isString; null otherwise.

Functions

open override fun renderedString(): String

Returns the literal content for YamlLiteral; "null" for YamlNull.

fun toYamlElement(): YamlElement

Returns the YamlPrimitive backing this adapter as a YamlElement.

fun KpaElement.toYamlElement(): YamlElement

Returns the YamlElement backing this adapter, or throws if this is not a YamlElementAdapter.