scalax.file

Path

object Path

The object for constructing Path objects and for containing implicits from strings and java.file.Files to Scala paths.

All Paths constructed by this factory are created for the default filesystem

Since

0.1

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Path
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Closeable = AnyRef { def close(): Unit }

Value Members

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

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

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

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

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

    Definition Classes
    Any
  6. object AccessModes

    Enumeration of the Access modes possible for accessing files

  7. def apply(jfile: File): DefaultPath

    Create a Path on the default files system from a java.file.File

    Create a Path on the default files system from a java.file.File

    jfile

    the file to use for creating the Path

  8. def apply(uri: URI): Option[Path]

    Create a Path from a URI.

    Create a Path from a URI.

    both the filesystem and the path can be determined from from the uri. For example:

    • file://c:\dir will create an absolute Path from the default filesystem with the Path = c:\dir
    • jar://classes.jar!dir creates a Path to the dir directory in the jar filesystem classes.jar
    uri

    The uri specifying the filesystem and path

    returns

    A path object

    Exceptions thrown
    IOException

    if the filesystem cannot be loaded or if the path cannot be created with that filesystem

  9. def apply(pathRepresentation: String, separator: Char): DefaultPath

  10. def apply(path: String*): DefaultPath

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def createTempDirectory(prefix: String = FileSystem.default.randomPrefix, suffix: String = null, dir: String = null, deleteOnExit: Boolean = true, attributes: TraversableOnce[FileAttribute[_]] = Nil): DefaultPath

    Creates an empty directory in the provided directory with the provided prefix and suffixes.

    Creates an empty directory in the provided directory with the provided prefix and suffixes. The directory will not replace an existing file/directory and it is guaranteed to be unique and not previously used by another process at time of creation.

    prefix

    the starting characters of the directory name. Default is a randomly generated prefix

    suffix

    the last characters of the directory name Default is null (no suffix)

    dir

    the directory to create the directory in. If null or not declared the directory will be created in the system temporary folder Default is null (system/user temp folder)

    deleteOnExit

    If true then the directory and all contained folders will be deleted when the JVM is shutdown. Default is true

    attributes

    The attributes to create on the file. Default is Nil(default system file attributes)

  14. def createTempFile(prefix: String = FileSystem.default.randomPrefix, suffix: String = null, dir: String = null, deleteOnExit: Boolean = true, attributes: TraversableOnce[FileAttribute[_]] = Nil): DefaultPath

    Creates an empty file in the provided directory with the provided prefix and suffixes.

    Creates an empty file in the provided directory with the provided prefix and suffixes. The file will not replace an existing file and it is guaranteed to be unique and not previously used by another process at time of creation.

    prefix

    the starting characters of the file name. Default is a randomly generated prefix

    suffix

    the last characters of the file name Default is null (no suffix)

    dir

    the directory to create the file in. If null or not declared the file will be created in the system temporary folder Default is null (system/user temp folder)

    deleteOnExit

    If true then the file will be deleted when the JVM is shutdown Default is true

    attributes

    The attributes to create on the file. Default is Nil(default system file attributes)

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def fromString(path: String): DefaultPath

    Create a Path from a string

    Create a Path from a string

    path

    the string to use for creating the Path

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def roots: Set[DefaultPath]

    Lists the roots of the default filesystem

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. def unapplySeq(pathExpr: Path): Option[Seq[String]]

    Allows matching on the path segments of a Path

    Allows matching on the path segments of a Path

    Path("c:","dir", "file")

    both of the above examples will match the same path

    For more on matching Paths see scalax.file.PathMatcher

  29. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any

Ungrouped