quarkdown-core/com.quarkdown.core.pipeline.output/OutputArtifact

OutputArtifact

interface OutputArtifact<T> : OutputResource

Represents an OutputResource that contains data. When visited by a FileResourceExporter, this resource is exported to a file whose extension is determined by the resource's type.

Parameters

T

type of data the resource contains

See also

Inheritors

Properties

Link copied to clipboard
abstract val content: T

Content data of the resource.

Link copied to clipboard
val OutputArtifact<*>.fileExtension: String

File extension relative to the ArtifactType of this resource.

Link copied to clipboard
val OutputResource.fileNameWithoutExtension: String

Name of the corresponding file of this resource, without the extension, with symbols removed and spaces replaced with dashes.

Link copied to clipboard
val OutputArtifact<*>.fullFileName: String

Full name of the file, including the extension relative to the ArtifactType of this resource.

Link copied to clipboard
abstract val name: String

Name of the resource (without file extensions).

Link copied to clipboard
abstract val type: ArtifactType

Type of content the resource contains.

Functions

Link copied to clipboard
abstract fun <T> accept(visitor: OutputResourceVisitor<T>): T

Accepts a visitor to perform operations on the resource.

Link copied to clipboard
fun OutputResource.saveTo(directory: File): File

Saves this resource to file in a directory.