scala.tools.nsc.io

Path

class Path extends AnyRef

The Path constructor is private so we can enforce some semantics regarding how a Path might relate to the world.

Source
Path.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Path
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Path to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Path, B)

    Implicit information
    This member is added by an implicit conversion from Path to ArrowAssoc[Path] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def /(child: File): File

  7. def /(child: Directory): Directory

  8. def /(child: Path): Path

    Creates a new Path with the specified path appended.

    Creates a new Path with the specified path appended. Assumes the type of the new component implies the type of the result.

  9. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  11. def addExtension(ext: String): Path

  12. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  13. def canRead: Boolean

  14. def canWrite: Boolean

  15. def changeExtension(ext: String): Path

  16. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  17. def createDirectory(force: Boolean = true, failIfExists: Boolean = false): Directory

  18. def createFile(failIfExists: Boolean = false): File

  19. def delete(): Boolean

  20. def deleteIfExists(): Boolean

  21. def deleteRecursively(): Boolean

    Deletes the path recursively.

    Deletes the path recursively. Returns false on failure. Use with caution!

  22. def endsWith(other: Path): Boolean

  23. def ensuring(cond: (Path) ⇒ Boolean, msg: ⇒ Any): Path

    Implicit information
    This member is added by an implicit conversion from Path to Ensuring[Path] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (Path) ⇒ Boolean): Path

    Implicit information
    This member is added by an implicit conversion from Path to Ensuring[Path] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): Path

    Implicit information
    This member is added by an implicit conversion from Path to Ensuring[Path] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): Path

    Implicit information
    This member is added by an implicit conversion from Path to Ensuring[Path] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  28. def equals(other: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Path → AnyRef → Any
  29. def exists: Boolean

  30. def extension: String

  31. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  32. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Path to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  33. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  34. def hasExtension(ext: String, exts: String*): Boolean

  35. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    Path → AnyRef → Any
  36. def ifDirectory[T](f: (Directory) ⇒ T): Option[T]

  37. def ifFile[T](f: (File) ⇒ T): Option[T]

  38. def isAbsolute: Boolean

  39. def isDirectory: Boolean

  40. def isEmpty: Boolean

  41. def isFile: Boolean

  42. def isFresher(other: Path): Boolean

  43. def isHidden: Boolean

  44. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  45. def isRootPath: Boolean

  46. def isSame(other: Path): Boolean

  47. def isValid: Boolean

  48. val jfile: JFile

  49. def lastModified: Long

  50. def lastModified_=(time: Long): Boolean

  51. def length: Long

  52. def name: String

  53. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  54. def normalize: Path

  55. def notExists: Boolean

  56. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  57. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  58. def parent: Directory

    returns

    The path of the parent directory, or root if path is already root

  59. def parents: List[Directory]

  60. def path: String

  61. def relativize(other: Path): Path

  62. def resolve(other: Path): Path

  63. def root: Option[Path]

  64. def segments: List[String]

  65. val separator: Char

  66. val separatorStr: String

  67. def startsWith(other: Path): Boolean

  68. def stripExtension: String

  69. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  70. def toAbsolute: Path

  71. def toAbsoluteWithRoot(root: Path): Path

    If this path is absolute, returns it: otherwise, returns an absolute path made up of root / this.

  72. def toCanonical: Path

  73. def toDirectory: Directory

  74. def toFile: File

  75. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    Path → AnyRef → Any
  76. def toURI: URI

  77. def toURL: URL

  78. def touch(modTime: Long = System.currentTimeMillis): AnyVal

  79. def truncate(): Boolean

  80. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  81. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  82. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  83. def walk: Iterator[Path]

    Equivalent to walkFilter(_ => false).

  84. def walkFilter(cond: (Path) ⇒ Boolean): Iterator[Path]

    If this path is a container, recursively iterate over its contents.

    If this path is a container, recursively iterate over its contents. The supplied condition is a filter which is applied to each element, with that branch of the tree being closed off if it is true. So for example if the condition is true for some subdirectory, nothing under that directory will be in the Iterator; but otherwise each file and subdirectory underneath it will appear.

  85. def [B](y: B): (Path, B)

    Implicit information
    This member is added by an implicit conversion from Path to ArrowAssoc[Path] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Path to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (path: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Path to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (path: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Path

    Implicit information
    This member is added by an implicit conversion from Path to ArrowAssoc[Path] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (path: ArrowAssoc[Path]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Path

    Implicit information
    This member is added by an implicit conversion from Path to Ensuring[Path] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (path: Ensuring[Path]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Path to StringAdd

Inherited by implicit conversion any2stringfmt from Path to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Path to ArrowAssoc[Path]

Inherited by implicit conversion any2Ensuring from Path to Ensuring[Path]

No Group