Packages

c

laika.ast

SegmentedPath

case class SegmentedPath(segments: NonEmptyChain[String], suffix: Option[String] = None, fragment: Option[String] = None) extends Path with SegmentedVirtualPath with Product with Serializable

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

Instance Constructors

  1. new SegmentedPath(segments: NonEmptyChain[String], suffix: Option[String] = None, fragment: Option[String] = None)

Type Members

  1. type Self = Path
    Definition Classes
    PathVirtualPathGenericPath

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def /(path: RelativePath): Path

    Combines this path with the specified relative path.

    Combines this path with the specified relative path.

    Definition Classes
    SegmentedPathGenericPath
  4. 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
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. lazy val 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
    SegmentedVirtualPathGenericPath
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def copyWith(basename: String = basename, suffix: Option[String] = suffix, fragment: Option[String] = fragment): Path
    Attributes
    protected
    Definition Classes
    SegmentedPathGenericPath
  10. val depth: Int

    The depth of this path from the virtual root.

    The depth of this path from the virtual root.

    Definition Classes
    SegmentedPathPath
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val 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
    SegmentedPathGenericPath
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def isSubPath(other: Path): Boolean

    Indicates whether this path is a sub-path of (or identical to) the specified other path.

    Indicates whether this path is a sub-path of (or identical to) the specified other path.

    Definition Classes
    SegmentedPathPath
  16. lazy 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.

    Definition Classes
    SegmentedVirtualPathGenericPath
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. lazy val parent: Path

    The parent of this path.

    The parent of this path. Will return this if this path represents a root node.

    Definition Classes
    SegmentedPathPath
  21. val pathPrefix: String
    Attributes
    protected
    Definition Classes
    SegmentedPathSegmentedVirtualPath
  22. def relative: RelativePath

    Interprets this path as a relative path - a shortcut for relativeTo(Root).

    Interprets this path as a relative path - a shortcut for relativeTo(Root).

    Definition Classes
    Path
  23. def relativeTo(path: Path): RelativePath

    Interprets this path relative to some other path.

    Interprets this path relative to some other path.

    The reference path is interpreted as a document path, as relative paths are most commonly used from the perspective of a document, not a tree node.

    Definition Classes
    SegmentedPathPath
  24. val segments: NonEmptyChain[String]

    The segments representing this path instance.

    The segments representing this path instance. The last segment does not include the suffix or fragment parts

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

    Definition Classes
    SegmentedPathGenericPath
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    SegmentedVirtualPath → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. 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
  32. 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
  33. 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
  34. 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
  35. 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 SegmentedVirtualPath

Inherited from Path

Inherited from VirtualPath

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenericPath

Inherited from AnyRef

Inherited from Any

Ungrouped