laika-io
API
Generated with
laika-io/laika/laika.io/laika.io.model/InputTree

InputTree

laika.io.model.InputTree
See theInputTree companion object
case class InputTree[F[_]](textInputs: Seq[TextInput[F]], binaryInputs: Seq[BinaryInput[F]], parsedResults: Seq[ParserResult], providedPaths: Seq[StaticDocument], sourcePaths: Seq[FilePath])

A (virtual) tree of input documents, either obtained from scanning a directory recursively or constructed programmatically (or a mix of both).

Even though the documents are specified as a flat sequence, they logically form a tree based on their virtual path.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def +(textInput: TextInput[F]): InputTree[F]
def +(binaryInput: BinaryInput[F]): InputTree[F]
def +(parsedResult: ParserResult): InputTree[F]
def +(providedPath: StaticDocument): InputTree[F]
def ++(other: InputTree[F]): InputTree[F]

Merges the inputs of two trees recursively.

Merges the inputs of two trees recursively.

This method does not perform any de-duplication in case both trees contain entries with the same virtual path, which would lead to errors when such a tree is used as input for a transformation. If one tree should take precedence over the other in case of duplicates, use overrideWith instead.

Attributes

def overrideWith(overrides: InputTree[F]): InputTree[F]

Overrides inputs in this instance with the provided inputs.

Overrides inputs in this instance with the provided inputs.

Merges the inputs of two trees recursively, like the ++ method, but with the main difference that in case both trees contain an entry with the same virtual path, the one in the overriding tree will take precedence and the one in this tree will be removed.

Attributes

def remove(paths: Set[Path]): InputTree[F]

Returns a new input tree with all inputs matching the provided exclusions removed from this tree.

Returns a new input tree with all inputs matching the provided exclusions removed from this tree.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val allPaths: Seq[Path]

A collection of all paths in this input tree, which may contain duplicates.

A collection of all paths in this input tree, which may contain duplicates.

Attributes

Generated with