laika-core
API
Generated with
laika-core/laika/laika.ast/RelativePath/CurrentDocument

CurrentDocument

laika.ast.RelativePath$.CurrentDocument
See theCurrentDocument companion object
case class CurrentDocument(fragment: Option[String]) extends RelativePath

Represent the current document.

Attributes

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

Members list

Type members

Inherited types

type Self = RelativePath

Attributes

Inherited from:
RelativePath

Value members

Concrete methods

def /(path: RelativePath): RelativePath

Combines this path with the specified relative path.

Combines this path with the specified relative path.

Attributes

override def withFragment(fragment: String): RelativePath

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

Definition Classes

Inherited 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

Inherited from:
GenericPath
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

Inherited from:
GenericPath
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
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

Inherited from:
GenericPath
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

Inherited from:
GenericPath
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

Inherited from:
GenericPath
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

Inherited from:
GenericPath

Concrete fields

val 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

val parent: RelativePath

The parent of this path.

The parent of this path.

Attributes

val parentLevels: Int

The number of levels this relative path points above the current level.

The number of levels this relative path points above the current level.

Attributes

val 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

override val toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Generated with