io.kjson.yaml.YAMLDocument.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kjson-yaml Show documentation
There is a newer version: 3.6
/*
 * @(#) YAMLDocument.kt
 *
 * kjson-yaml  Kotlin YAML processor
 * Copyright (c) 2020, 2021, 2023 Peter Wall
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.kjson.yaml

import io.kjson.JSONArray
import io.kjson.JSONBoolean
import io.kjson.JSONDecimal
import io.kjson.JSONInt
import io.kjson.JSONLong
import io.kjson.JSONObject
import io.kjson.JSONString
import io.kjson.JSONValue
import io.kjson.pointer.JSONPointer
import io.kjson.pointer.contains
import io.kjson.pointer.get
import io.kjson.yaml.YAML.boolTag
import io.kjson.yaml.YAML.floatTag
import io.kjson.yaml.YAML.intTag
import io.kjson.yaml.YAML.mapTag
import io.kjson.yaml.YAML.nullTag
import io.kjson.yaml.YAML.seqTag
import io.kjson.yaml.YAML.strTag

/**
 * A YAML document - the result of a YAML parsing operation.
 *
 * @author  Peter Wall
 */
class YAMLDocument(
    val rootNode: JSONValue?,
    internal val tagMap: Map,
    val majorVersion: Int,
    val minorVersion: Int
) {

    constructor(rootNode: JSONValue?, tagMap: Map = emptyMap()) :
            this(rootNode, tagMap, defaultMajorVersion, defaultMinorVersion)

    /**
     * Get the tag associated with the specified node.
     *
     * @param   pointer     a [JSONPointer] specifying the node
     * @return              the tag
     */
    fun getTag(pointer: JSONPointer): String {
        tagMap[pointer]?.let { return it }
        rootNode?.let { root ->
            if (pointer in root) {
                return when(root[pointer]) {
                    null -> nullTag
                    is JSONObject -> mapTag
                    is JSONArray -> seqTag
                    is JSONString -> strTag
                    is JSONInt -> intTag
                    is JSONLong -> intTag
                    is JSONDecimal -> floatTag
                    is JSONBoolean -> boolTag
                }
            }
        }
        throw YAMLException("Node does not exist - $pointer")
    }

    companion object {

        @Suppress("ConstPropertyName")
        const val defaultMajorVersion = 1
        @Suppress("ConstPropertyName")
        const val defaultMinorVersion = 2

    }

}