The error that occurred during processing, paired with the PipelineErrorHandler strategy to handle it. If null, no error occurred and the node is rendered normally via acceptOnSuccess.

fileSystem

open override val fileSystem: FileSystem?

isBackingCallBlock

open override val isBackingCallBlock: Boolean

Whether the synthesized backing call should be treated as a block call. Defaults to true; inline primitive nodes should override to false so the inline output mapper is used during expansion.

label

open override val label: InlineContent

style

open override val style: NodeStyle

text

open override val text: InlineContent

The text of the node as processed inline content.

title

open override val title: InlineContent?

url

open override val url: String

Functions

open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts the error as a node if an error is present, otherwise accepts this node normally via acceptOnSuccess.

acceptOnSuccess

open override fun <T> acceptOnSuccess(visitor: NodeVisitor<T>): T

Visits this node with the given visitor when no error is present.

copy

open override fun copy(url: String): Link

Creates a copy of this link with the given url.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

getResolvedUrl

fun LinkNode.getResolvedUrl(context: Context): String

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

Retrieves the stored media associated with this node, if any.

setError

fun ErrorCapableNode.setError(throwable: Throwable, context: Context)

Sets the given throwable as the error of this node, paired with the error handler from context.

setResolvedUrl

fun LinkNode.setResolvedUrl(context: MutableContext, resolvedUrl: String)

Registers the resolved path of this node within the document handled by context.

stripAnchor

fun stripAnchor(): Pair<Link, String>?

Strips the anchor (fragment) from the URL.

toFunctionCallArguments

open override fun toFunctionCallArguments(): List<FunctionCallArgument>

Materializes this node's properties into the arguments of the backing function call. Argument names must match the parameter names of the function identified by backingFunctionName.

withChildren

fun Node.withChildren(newChildren: List<Node>): Node

Returns a copy of this node with its children replaced by newChildren.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue