Packages

sealed trait Path extends PathBase

Represents a path inside a virtual tree of documents.

Linear Supertypes
PathBase, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Root, SegmentedPath
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Path
  2. PathBase
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

    Combines this path with the specified relative path.

  2. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  3. abstract def depth: Int

    The depth of this path from the virtual root.

  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
    PathBase
  5. abstract def isSubPath(other: Path): Boolean

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

  6. 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
    PathBase
  7. abstract def parent: Path

    The parent of this path.

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

  8. abstract def productArity: Int
    Definition Classes
    Product
  9. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  10. abstract def relativeTo(refPath: 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.

  11. 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
    PathBase

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): Path

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

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

    Definition Classes
    PathBase
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementName(n: Int): String
    Definition Classes
    Product
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. def productIterator: Iterator[Any]
    Definition Classes
    Product
  20. def productPrefix: String
    Definition Classes
    Product
  21. def relative: RelativePath

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

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. def withBasename(name: String): Path

    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.

  28. def withFragment(fragment: String): Path

    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.

  29. def withSuffix(suffix: String): Path

    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.

  30. def withoutFragment: Path

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

  31. def withoutSuffix: Path

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

Inherited from PathBase

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped