commonMain.nl.adaptivity.xmlutil.dom2.Node.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-base Show documentation

Component of the XMLUtil library

There is a newer version: 0.90.0-RC3

/*
 * Copyright (c) 2024.
 *
 * This file is part of xmlutil.
 *
 * This file is licenced to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You should have received a copy of the license with the source distribution.
 * Alternatively, you may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package nl.adaptivity.xmlutil.dom2

import kotlinx.serialization.Serializable

@Serializable(NodeSerializer::class)
public interface Node {
    public val nodetype : NodeType
    public fun getNodeType(): Short = nodetype.value
    public fun getNodeName(): String
    public fun getOwnerDocument(): Document
    public fun getParentNode(): Node?
    public fun getTextContent(): String?
    public fun setTextContent(value: String)
    public fun getChildNodes(): NodeList
    public fun getFirstChild(): Node?
    public fun getLastChild(): Node?
    public fun getPreviousSibling(): Node?
    public fun getNextSibling(): Node?
    public fun getParentElement(): Element? = parentNode as? Element

    public fun lookupPrefix(namespace: String): String?

    public fun lookupNamespaceURI(prefix: String): String?

    public fun appendChild(node: Node): Node

    public fun replaceChild(oldChild: Node, newChild: Node): Node

    public fun removeChild(node: Node): Node

}

public inline val Node.nodeType: Short get() = getNodeType()
public inline val Node.nodeName: String get() = getNodeName()
public inline val Node.ownerDocument: Document get() = getOwnerDocument()
public inline val Node.parentNode: Node? get() = getParentNode()
public inline val Node.textContent: String? get() = getTextContent()
public inline val Node.childNodes: NodeList get() = getChildNodes()
public inline val Node.firstChild: Node? get() = getFirstChild()
public inline val Node.lastChild: Node? get() = getLastChild()
public inline val Node.previousSibling: Node? get() = getPreviousSibling()
public inline val Node.nextSibling: Node? get() = getNextSibling()