Packages

t

laika.ast

GenericPath

trait GenericPath extends AnyRef

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).

Linear Supertypes
AnyRef, Any
Known Subclasses
Path, Root, RelativePath, CurrentDocument, CurrentTree, Parent, SegmentedPath, SegmentedRelativePath, SegmentedVirtualPath, VirtualPath
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericPath
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Self <: GenericPath

Abstract Value Members

  1. abstract def /(path: RelativePath): Self

    Combines this path with the specified relative path.

  2. abstract def copyWith(basename: String = basename, suffix: Option[String] = suffix, fragment: Option[String] = fragment): Self
    Attributes
    protected
  3. abstract 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.

  4. abstract def name: String

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

  5. abstract def suffix: Option[String]

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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def /(name: String): Self

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

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def basename: String

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

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. 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.

  22. 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.

  23. 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.

  24. def withoutFragment: Self

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

  25. def withoutSuffix: Self

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped