Packages

sealed trait VirtualPath extends GenericPath with Product with Serializable

The abstract base for absolute and relative paths within Laika's virtual path abstraction.

A path in Laika is always virtual and not pointing to a path in the file system, even if the data was obtained by scanning a directory. This is because in Laika transformation input can come from different sources, e.g. from two different directories merged into a single virtual tree in memory with some additional documents added programmatically without any file system reference.

Linear Supertypes
Serializable, Serializable, Product, Equals, GenericPath, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VirtualPath
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. GenericPath
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Self <: VirtualPath
    Definition Classes
    VirtualPathGenericPath

Abstract Value Members

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

    Combines this path with the specified relative path.

    Combines this path with the specified relative path.

    Definition Classes
    GenericPath
  2. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  3. abstract def copyWith(basename: String = basename, suffix: Option[String] = suffix, fragment: Option[String] = fragment): Self
    Attributes
    protected
    Definition Classes
    GenericPath
  4. 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.

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

    Definition Classes
    GenericPath
  5. abstract 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.

    Definition Classes
    GenericPath
  6. abstract def productArity: Int
    Definition Classes
    Product
  7. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  8. abstract 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 ..

    Definition Classes
    GenericPath

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.

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

    Definition Classes
    GenericPath
  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).

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

    Definition Classes
    GenericPath
  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. def productIterator: Iterator[Any]
    Definition Classes
    Product
  17. def productPrefix: String
    Definition Classes
    Product
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. 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.

    Definition Classes
    GenericPath
  24. 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.

    Definition Classes
    GenericPath
  25. 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.

    Definition Classes
    GenericPath
  26. 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.

    Definition Classes
    GenericPath
  27. 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.

    Definition Classes
    GenericPath

Deprecated Value Members

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericPath

Inherited from AnyRef

Inherited from Any

Ungrouped