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

Package-level declarations

Types

Possible types of content an OutputArtifact contains.

class BinaryOutputArtifact(val name: String, val content: ByteArray, val type: ArtifactType) : OutputArtifact<ByteArray>

Represents an OutputResource that contains binary data.

FileResourceExporter

class FileResourceExporter(location: File, write: Boolean = true) : OutputResourceVisitor<File>

A visitor that saves each type of OutputResource to a file and returns it.

LazyOutputArtifact

data class LazyOutputArtifact(val name: String, val content: () -> ByteArray, val type: ArtifactType) : OutputArtifact<() -> ByteArray>

Represents a BinaryOutputArtifact whose content is lazily loaded on demand (via accept).

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.

OutputResource

interface OutputResource

Abstraction of an output entity produced by the pipeline. A resource is saved to file via a FileResourceExporter.

OutputResourceGroup

data class OutputResourceGroup(val name: String, val resources: Set<OutputResource>) : OutputResource

Represents an OutputResource that contains other resources (and does not provide content of its own). When visited by a FileResourceExporter, this resource is exported to a directory.

OutputResourceVisitor

interface OutputResourceVisitor<T>

Visitor for OutputResource types.

TextOutputArtifact

data class TextOutputArtifact(val name: String, val content: CharSequence, val type: ArtifactType) : OutputArtifact<CharSequence>

Represents an OutputResource that contains text data.