laika-core
API
Generated with
laika-core/laika.ast/GenericPath

GenericPath

laika.ast.GenericPath
trait GenericPath

Generic base trait for all path abstractions in Laika.

The most commonly used sub-type is VirtualPath which is used to assign paths to trees and documents within a Laika transformation.

This trait is the only one within the Path API that is not sealed, to allow for implementations in other modules (e.g. FilePath in laika-io).

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Path
object Root.type
object CurrentTree.type
class Parent

Members list

Concise view

Type members

Types

Value members

Abstract methods

def /(path: RelativePath): Self

Combines this path with the specified relative path.

Combines this path with the specified relative path.

Attributes

protected def copyWith(basename: String, suffix: Option[String], fragment: Option[String]): Self
def fragment: Option[String]

The fragment part of the path (after a # in the last segment), or None if this path does not have a fragment component.

The fragment part of the path (after a # in the last segment), or None if this path does not have a fragment component.

Attributes

def name: String

The local name of this path, without the optional fragment part, but including the suffix if present.

The local name of this path, without the optional fragment part, but including the suffix if present.

Attributes

def suffix: Option[String]

The suffix of None if this path name does not have a file suffix separated by a ..

The suffix of None if this path name does not have a file suffix separated by a ..

Attributes

Concrete methods

def /(name: String): Self

Creates a new path with the specified name as an immediate child of this path.

Creates a new path with the specified name as an immediate child of this path.

Attributes

def basename: String

The base name of this path, without the suffix (if present).

The base name of this path, without the suffix (if present).

Attributes

def withBasename(name: String): Self

Returns a new path that replaces the base name with the specified new name while keeping both, suffix and fragment, in case they are present.

Returns a new path that replaces the base name with the specified new name while keeping both, suffix and fragment, in case they are present.

Attributes

def withFragment(fragment: String): Self

Returns a new path that either replaces the existing fragment component with the specified one or appends it if this path does not have a component yet.

Returns a new path that either replaces the existing fragment component with the specified one or appends it if this path does not have a component yet.

Attributes

def withSuffix(suffix: String): Self

Returns a new path that either replaces the existing suffix with the specified one or appends it if this path does not have a suffix yet.

Returns a new path that either replaces the existing suffix with the specified one or appends it if this path does not have a suffix yet.

Attributes

def withoutFragment: Self

Returns a new path that discards this path's fragment, if present.

Returns a new path that discards this path's fragment, if present.

Attributes

def withoutSuffix: Self

Returns a new path that discards this path's suffix, if present.

Returns a new path that discards this path's suffix, if present.

Attributes

Generated with