laika-docs
1.1.0
API
Generated with
laika-docs/laika/laika.io/laika.io.config/Artifact

Artifact

laika.io.config.Artifact
See theArtifact companion object
sealed abstract class Artifact

Represents an artifact with optional classifiers such as those used by binary renderers. The format is <basePath><classifiers>.<suffix> where classifiers is the empty string if the classifiers property is empty. Otherwise classifiers will be concatenated with - as separator and prefix.

Attributes

Companion
object
Source
Artifact.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def basePath: Path

The basePath for the artifact within the virtual tree, including the file name without suffix.

The basePath for the artifact within the virtual tree, including the file name without suffix.

Attributes

Source
Artifact.scala
def classifiers: Seq[String]

The classifiers to insert between basePath and suffix, with - as separator and prefix.

The classifiers to insert between basePath and suffix, with - as separator and prefix.

Attributes

Source
Artifact.scala
def suffix: String

The file suffix of the artifact.

The file suffix of the artifact.

Attributes

Source
Artifact.scala
def withClassifiers(cls: Seq[String]): Artifact

Returns a new Artifact with the specified classifiers applied.

Returns a new Artifact with the specified classifiers applied.

Attributes

Source
Artifact.scala

Concrete methods

def fullPath: Path

The full virtual Path for this Artifact, including all applied classifiers.

The full virtual Path for this Artifact, including all applied classifiers.

Attributes

Source
Artifact.scala
Generated with