scalax.file.defaultfs

DefaultPath

class DefaultPath extends Path with DefaultFileOps

Not Part of API

A file reference that locates a file using a system independent path. The file is not required to exist.

Self Type
DefaultPath
Since

1.0

Linear Supertypes
DefaultFileOps, Path, Ordered[Path], Comparable[Path], PathFinder[Path], FileOps, Seekable, Output, Input, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DefaultPath
  2. DefaultFileOps
  3. Path
  4. Ordered
  5. Comparable
  6. PathFinder
  7. FileOps
  8. Seekable
  9. Output
  10. Input
  11. AnyRef
  12. Any
  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

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

    Definition Classes
    AnyRef → Any
  4. def *[F](filter: F)(implicit factory: PathMatcherFactory[F]): PathSet[Path]

    Constructs a new finder that selects all paths with a name that matches filter and are immediate children of paths selected by this finder.

    Constructs a new finder that selects all paths with a name that matches filter and are immediate children of paths selected by this finder.

    Definition Classes
    PathPathFinder
  5. def **[F](filter: F)(implicit factory: PathMatcherFactory[F]): PathSet[Path]

    Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

    Constructs a new finder that selects all paths with a name that matches filter and are descendants of paths selected by this finder.

    Definition Classes
    PathPathFinder
  6. def ***: PathSet[Path]

    Definition Classes
    PathPathFinder
  7. def +++[U >: Path](includes: PathFinder[U]): PathSet[U]

    The union of the paths found by this PathSet with the paths found by 'paths'.

    The union of the paths found by this PathSet with the paths found by 'paths'. Note that if the same element is added twice it will be present twice in the PathFinder (in most implementations). Consider: (Path("a") +++ Path("a")).iterator. the iterator will return Path("a") twice.

    Definition Classes
    PathPathFinder
  8. def ---[U >: Path](excludes: PathFinder[U]): PathSet[Path]

    Excludes all paths from excludes from the paths selected by this PathSet.

    Excludes all paths from excludes from the paths selected by this PathSet.

    Definition Classes
    PathPathFinder
  9. def /(child: String): DefaultPath

    If child is relative, creates a new Path based on the current path with the child appended.

    If child is relative, creates a new Path based on the current path with the child appended. If child is absolute the child is returned

    <

    • if other is null return this
    • if other is absolute return other
    • if other is not absolute the return this append other

    @note child is a single child if it contains a path separator it will NOT be considered a separator character

    Examples include:

    
    path / "child" / "grandchild"
    path / ".." / "sibling"
    
    

    Illegal examples include;

    
    path / "child/grandchild"
    path / "../sibling"
    
    
    In these cases an exception will be thrown

    returns

    A new path with the specified path appended

    Definition Classes
    DefaultPathPathPathFinder
    See also

    #\(String)

  10. final def /(child: Path): PathType

    Alias for /(child.

    Alias for /(child.name)

    returns

    A new path with the specified path appended

    Definition Classes
    Path
    See also

    #/(String)

  11. def /(pathRepresentation: String, separator: Char): PathType

    Add several children to this path.

    Add several children to this path. The sep character will be used to split the path string, A path will be created from the resulting sequence and finally all children will be added to this path.

    Examples:

    path / ("a,c,d,e", ',') // results in path / a / c / d / e
    path / ("/a/b/c/d/", '/') // results in path / a / b / c / d
    path / ("//../a","/") // results in path / .. / a
    
    path / ("/a",',') // results in an exception if / == Path.separator
    path / ("//",'/') // returns same Path
    Definition Classes
    Path
  12. def <(that: Path): Boolean

    Definition Classes
    Ordered
  13. def <=(that: Path): Boolean

    Definition Classes
    Ordered
  14. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  16. def >(that: Path): Boolean

    Definition Classes
    Ordered
  17. def >=(that: Path): Boolean

    Definition Classes
    Ordered
  18. final def \(child: Path): PathType

    Alias for /(Path)

    Alias for /(Path)

    Definition Classes
    Path
    See also

    #/(Path)

  19. def \(pathRepresentation: String, separator: Char): PathType

    Definition Classes
    Path
  20. def \(child: String): PathType

    Alias for /(String)

    Alias for /(String)

    Definition Classes
    PathPathFinder
    See also

    /(String)

  21. def access: AccessSet

    Reads the access modes from the file and returns the Set This does not lock the file so the modes could be out of date even by the time the method returns if used in a heavily parallel environment

    Reads the access modes from the file and returns the Set This does not lock the file so the modes could be out of date even by the time the method returns if used in a heavily parallel environment

    returns

    the access modes set on the file

    Definition Classes
    Path
  22. def access_=(accessModes: Iterable[AccessMode]): Unit

    Sets the standard access modes on the underlying path.

    Sets the standard access modes on the underlying path. If the underlying object does not exist it will throw an exception. If the underlying system does not support support the mode the mode will be ignored

    accessModes

    the modes to set on the file in (if possible) a single atomic update

    Definition Classes
    DefaultPathPath
  23. def access_=(accessModes: String): Unit

    Short cut for setting the standard access modes on the underlying path.

    Short cut for setting the standard access modes on the underlying path. If the underlying object does not exist it will throw an exception. If the underlying system does not support support the mode the mode will be ignored

    accessModes

    string representation of the modes. The standard options include r - read, w - write, e - execute. The options are filesystem dependent

    Definition Classes
    Path
  24. def append(string: String)(implicit codec: Codec = Codec.default): Unit

    Append a string to the end of the Seekable object.

    Append a string to the end of the Seekable object.

    string

    the data to write

    codec

    the codec of the string to be written. The string will be converted to the encoding of scalax.io.Codec

    Definition Classes
    Seekable
  25. def append[T](data: T)(implicit converter: OutputConverter[T]): Unit

    Append bytes to the end of a file

    Append bytes to the end of a file

    Important: The use of an Array is highly recommended because normally arrays can be more efficiently written using the underlying APIs

    data

    The data to write. This can be any type that has a scalax.io.OutputConverter associated with it. There are predefined $outputConverters for several types. See the scalax.io.OutputConverter object for the predefined types and for objects to simplify implementing custom scalax.io.OutputConverter

    $converterParam

    Definition Classes
    Seekable
  26. def appendChannel[U](f: (SeekableByteChannel) ⇒ U): U

    Attributes
    protected
    Definition Classes
    Seekable
  27. def appendIntsAsBytes(data: Int*): Unit

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes.

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes. In other words just taking the first byte. This is pretty common in Java.io style IO. IE

    outputStream.write(1)

    1 is written as a single byte.

    Definition Classes
    Seekable
  28. def appendStrings(strings: Traversable[String], separator: String = "")(implicit codec: Codec = Codec.default): Unit

    Append several strings to the end of the Seekable object.

    Append several strings to the end of the Seekable object.

    strings

    The strings to write

    separator

    A string to add between each string. It is not added to the before the first string or after the last.

    codec

    The codec of the strings to be written. The strings will be converted to the encoding of scalax.io.Codec

    Definition Classes
    Seekable
  29. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  30. def assertExists: Unit

    Attributes
    protected
    Definition Classes
    Path
  31. def attributes: Set[FileAttribute[_]]

    Definition Classes
    Path
  32. def attributes_=(attrs: TraversableOnce[FileAttribute[_]]): Unit

    Definition Classes
    Path
  33. def blocks(blockSize: Option[Int] = None): LongTraversable[ByteBlock]

    Read the input as blocks of bytes.

    Read the input as blocks of bytes. This method should be avoided unless the maximum performance is absolutely required because bytes provides very good performance and is a better API for most applications.

    However since it better reflects how data is read with most input sources (like InputStreams and ReadableByteChannels); blocks is slightly more performance than bytes and therefore can be used when performance is the most important consideration.

    blockSize

    block size can optionally be specified but the default is normally acceptable.

    Definition Classes
    SeekableInput
  34. def byteArray: Array[Byte]

    This method aspires to be the fastest way to read a stream of known length into memory.

    This method aspires to be the fastest way to read a stream of known length into memory.

    Definition Classes
    Input
  35. def bytes: LongTraversable[Byte]

    Obtains a Traversable for conveniently processing the resource as bytes.

    Obtains a Traversable for conveniently processing the resource as bytes.

    returns

    an non-strict traversable over all the bytes

    Definition Classes
    SeekableInput
  36. def bytesAsInts: LongTraversable[Int]

    Obtains a Traversable for conveniently processing the file as Ints.

    Obtains a Traversable for conveniently processing the file as Ints.

    returns

    an non-strict traversable over all the bytes with the bytes being represented as Ints

    Definition Classes
    SeekableInput
  37. def canExecute: Boolean

    Definition Classes
    DefaultPathPath
  38. def canRead: Boolean

    Definition Classes
    DefaultPathPath
  39. def canWrite: Boolean

    Definition Classes
    DefaultPathPath
  40. def channel(openOptions: OpenOption*): SeekableByteChannelResource[SeekableFileChannel]

    Definition Classes
    DefaultFileOps
  41. def chars(implicit codec: Codec): LongTraversable[Char]

    The characters in the object.

    The characters in the object.

    If the codec is not the same as the source codec (the codec of the underlying data) then the characters will converted to the desired codec.

    codec

    The codec representing the desired encoding of the characters

    returns

    an traversable of all the characters

    Definition Classes
    FileOpsSeekableInput
  42. def checkAccess(modes: AccessMode*): Boolean

    Check if the referenced file both exists and be accessed with the requested modes

    Check if the referenced file both exists and be accessed with the requested modes

    modes

    the modes to check for on the file. If empty then only existance is checked

    returns

    true if all modes are available on the file

    Definition Classes
    DefaultPathPath
  43. def checkAccess(modes: String): Boolean

    Check modes using the rwx characters.

    Check modes using the rwx characters. The string can be from 1-3 characters long and can be r w x in any order. Spaces are ignored

    Definition Classes
    Path
  44. def children[U >: Path, F](filter: F, options: Traversable[LinkOption])(implicit factory: PathMatcherFactory[F]): PathSet[Path]

    An iterable over the contents of the directory.

    An iterable over the contents of the directory. This is simply walkTree with depth=1.

    The filter parameter restricts what paths are available through the PathSet. This is different from using the filter, filterFold or filterEach methods in PathSet because PathMatchers can be used by the underlying filesystem natively and can potentially provide dramatically improved performance for very large directories.

    filter

    A filter that restricts what paths are available in the PathSet If the filter is a PathMatcher and the underlying filesystem supports the PatchMatcher implementation then the maximum performance will be achieved. All Paths that are passed to matcher is relative to this Path Default is PathMatcher.All

    returns

    A managed resource managing a PathSet.

    Definition Classes
    Path
    See also

    FileSystem#matcher(String,String)

    Path.Matching

    Path#walkTree

  45. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  46. def compare(other: Path): Int

    Compares this path to the other lexigraphically.

    Compares this path to the other lexigraphically.

    Definition Classes
    Path → Ordered
  47. def compareTo(that: Path): Int

    Definition Classes
    Ordered → Comparable
  48. def context: ResourceContext

    Get the Resource context that configures how the underlying resource is accessed

    Get the Resource context that configures how the underlying resource is accessed

    returns

    the associated ResourceContext

    Definition Classes
    PathSeekableInput
  49. def copyDataTo(output: Output): Unit

    Copy all data from this Input object to the Output object as efficiently as possible.

    Copy all data from this Input object to the Output object as efficiently as possible.

    output

    output sink to copy the data to

    Definition Classes
    PathInput
  50. def copyTo[P <: Path](target: P, createParents: Boolean, copyAttributes: Boolean, replaceExisting: Boolean, depth: Int): P

    Copy the underlying object if it exists to the target location.

    Copy the underlying object if it exists to the target location. If the underlying object is a directory it is not copied recursively.

    target

    the target path to copy the filesystem object to.

    copyAttributes

    if true then copy the File attributes of the object as well as the data. True by default

    replaceExisting

    if true then replace any existing target object unless it is a non-empty directory in which case an IOException is thrown. False by default

    depth

    The depth of the copy if the path is a Directory. A depth of 0 means only the current Path is copied A depth of 1 means all children are copied as well, etc... default is entire tree

    returns

    the path to the new copy

    Definition Classes
    Path
    Exceptions thrown
    IOException

    if the copy could not be satisfied because the target could not be written to or if this path cannot be copied

  51. def createDirectory(createParents: Boolean = true, failIfExists: Boolean = true, accessModes: Iterable[AccessMode] = List(Read,Write,Execute), attributes: TraversableOnce[FileAttribute[_]] = Nil): PathType

    Create the directory referenced by this path.

    Create the directory referenced by this path.

    If failIfExists then IOException is thrown if the file already exists. In the next Java 7 only version it will throw FileAlreadyExistsException

    An exception is always thrown if the file is a directory and that directory contains children

    An exception will also be thrown if the parent directory does not have write permission

    createParents

    If true then the containing directories will be created if they do not exist Default is true

    failIfExists

    If true and an object exists then an exception will be thrown If false then the object will be deleted if possible If not possible to delete the object or it is a non-empty directory an exception will be thrown Default is true

    accessModes

    The access modes that to set on the file Default is Read,Write

    attributes

    Filesystem specific attributes to fromString to the file Ignored unless on Java 7+ JVM

    Definition Classes
    Path
    Exceptions thrown
    IOException

    if file or directory already exists. In the next Java 7 only version it will throw FileAlreadyExistsException If the process does not have write permission to the parent directory If parent directory does not exist

  52. def createFile(createParents: Boolean = true, failIfExists: Boolean = true, accessModes: Iterable[AccessMode] = List(Read,Write), attributes: TraversableOnce[FileAttribute[_]] = Nil): PathType

    Create the file referenced by this path.

    Create the file referenced by this path.

    If failIfExists then IOException is thrown if the file already exists. In the next Java 7 only version it will throw FileAlreadyExistsException

    An exception is always thrown if the file is a directory and that directory contains children

    An Exception will also be thrown if the parent directory does not have write permission

    createParents

    If true then the containing directories will be created if they do not exist Default is true

    failIfExists

    If true and an object exists then an exception will be thrown If false then the object will be deleted if possible If not possible to delete the object or it is a non-empty directory an exception will be thrown Default is true

    accessModes

    The access modes that to set on the file Default is Read,Write

    attributes

    Filesystem specific attributes to fromString to the file Ignored unless on Java 7+ JVM

    Definition Classes
    Path
    Exceptions thrown
    IOException

    If file or directory already exists. In the next Java 7 only version it will throw FileAlreadyExistsException If the process does not have write permission to the parent directory If parent directory does not exist

  53. def delete(force: Boolean): DefaultPath.this.type

    Deletes the file or throws an IOException on failure

    Deletes the file or throws an IOException on failure

    force

    if the file is write protected force will override the write protection and delete the file. If not force then an IOException will be thrown indicating failure of deletion. Default is false

    returns

    this

    Definition Classes
    DefaultPathPath
    Exceptions thrown
    IOException

    if the file could not be deleted

  54. def deleteIfExists(force: Boolean = false): Boolean

    Delete the filesystem object if the file exists.

    Delete the filesystem object if the file exists.

    If the file exists and is a non-empty Directory or there is some other reason the operation cannot be performed an IOException will be thrown.

    If the file does not exist it will return false

    force

    if the file is write protected force will override the write protection and delete the file. If not force then an IOException will be thrown indicating failure of deletion. Default is false

    Definition Classes
    Path
    Exceptions thrown
    IOException

    if the file cannot be written or if there is some other reason the file cannot be deleted. For example if the file is a non-empty directory

  55. def deleteRecursively(force: Boolean = false, continueOnFailure: Boolean = false): (Int, Int)

    Deletes the directory recursively.

    Deletes the directory recursively.

    This method does not detect circular directory graphs and does not promise to perform the delete in an atomic operation

    Use with caution!

    force

    if the file is write protected force will override the write protection and delete the file. If not force then an IOException will be thrown indicating failure of deletion. Default is false

    continueOnFailure

    If false then method will throw an exception when encountering a file that cannot be deleted. Otherwise it will continue to delete all the files that can be deleted. Note: this method is not transactional, all files visited before failure are deleted.

    returns

    Tuple with (The number of files deleted, The number of files remaining)

    Definition Classes
    Path
    Exceptions thrown
    IOException

    when continueOnFailure is false and a file cannot be deleted

  56. def descendants[U >: Path, F](filter: F, depth: Int, options: Traversable[LinkOption])(implicit factory: PathMatcherFactory[F]): BasicPathSet[DefaultPath]

    An iterable that traverses all the elements in the directory tree down to the specified depth

    An iterable that traverses all the elements in the directory tree down to the specified depth

    The filter parameter is a function because the PathSet can return files from many directories. The function provides the mechanism for declaring which PathMatcher to use at each level. The two parameters are original path and the path to be visited relative to the original path. By default the function always returns None.

    If the depth parameter is non-negative then that restricts the depth that will be traversed. The value 0 will not return any elements, depth = 1 is essentially the path#directoryStream(Option,Boolean) method and values < 0 will return all elements at any depth.

    The traversal order is pre-order.

    No exceptions will be thrown by this method if it is called and the Path is a File or does not exist. Instead the PathSet will throw a NotDirectoryException when a method is called and the underlying object is not a Directory.

    filter

    A filter that restricts what paths are available in the PathSet If the filter is a PathMatcher and the underlying filesystem supports the PatchMatcher implementation then the maximum performance will be achieved. All Paths that are passed to matcher is relative to this Path Default is PathMatcher.All

    depth

    How deep down the tree to traverse 1 is just visit the objects in the directory negative values will visit entire tree Default is -1

    returns

    A managed resource managing a PathSet.

    Definition Classes
    DefaultPathPath
    See also

    FileSystem#matcher(String,String)

    Path.Matching

    Path#directoryStream(Option,Boolean)

  57. def doCopyFrom(input: Input): Unit

    If possible efficiently copy data from input.

    If possible efficiently copy data from input. It MUST NOT forward request to input's copyTo method because that could trigger an infinate loop

    Definition Classes
    PathOutput
  58. def doCreateDirectory(): Boolean

    NOT PUBLIC API: Create a directory for the current path without considering if the parents has been previously created.

    NOT PUBLIC API: Create a directory for the current path without considering if the parents has been previously created. This method should fail if the parent does not exist

    Definition Classes
    DefaultPathPath
  59. def doCreateFile(): Boolean

    NOT PUBLIC API: Create a file for the current path without considering if the parents has been previously created.

    NOT PUBLIC API: Create a file for the current path without considering if the parents has been previously created. This method should fail if the parent does not exist

    Definition Classes
    DefaultPathPath
  60. def doCreateParents(): Unit

    NOT PUBLIC API: Create all parent directories of the current Path

    NOT PUBLIC API: Create all parent directories of the current Path

    Definition Classes
    DefaultPathPath
  61. def endsWith(other: Path): Boolean

    True if this path ends with the other path

    True if this path ends with the other path

    returns

    True if this path ends with the other path

    Definition Classes
    Path
  62. final def eq(arg0: AnyRef): Boolean

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

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

    True if the path exists in the file system

    True if the path exists in the file system

    returns

    true if the path exists in the file system

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#exists

  65. lazy val extension: Option[String]

    The extension of the name of the path, if it exists.

    The extension of the name of the path, if it exists. if name ends with an extension (e.g. "foo.jpg") returns the extension ("jpg")

    returns

    the extension of the path

    Definition Classes
    Path
  66. def fileChannel(openOptions: OpenOption*): Some[SeekableByteChannelResource[SeekableFileChannel]]

    Definition Classes
    DefaultFileOps
  67. def fileOption: Option[File]

    Return a java.

    Return a java.io.File if possible

    Definition Classes
    DefaultPathPath
  68. val fileSystem: DefaultFileSystem

    Definition Classes
    DefaultPathPath
  69. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  70. final def getClass(): Class[_]

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

    Definition Classes
    Path → AnyRef → Any
  72. def inputStream: InputStreamResource[FileInputStream]

    Definition Classes
    DefaultFileOps
  73. def insert[T](position: Long, data: T)(implicit converter: OutputConverter[T]): Any

    Inserts data at a position in the Seekable.

    Inserts data at a position in the Seekable. The actual position in the Seekable where the data is inserted depends on the type of data being written. For example if Longs are being written then position calculated as position * 8

    Important: The use of an Array is highly recommended because normally arrays can be more efficiently written using the underlying APIs

    position

    The position where the data is inserted into the Seekable. The actual position in the Seekable where the data is inserted depends on the type of data being written. For example if Longs are being written then position calculated as position * 8

    data

    The data to write. This can be any type that has a scalax.io.OutputConverter associated with it. There are predefined $outputConverters for several types. See the scalax.io.OutputConverter object for the predefined types and for objects to simplify implementing custom scalax.io.OutputConverter

    $converterParam

    Definition Classes
    Seekable
  74. def insert(position: Long, string: String)(implicit codec: Codec = Codec.default): Unit

    Inserts a string at a position in the Seekable.

    Inserts a string at a position in the Seekable. This is a potentially inefficient because of the need to count characters. If the codec is not a fixed sized codec (for example UTF8) each character must be converted in the file up to the point of insertion.

    position

    The position in the file to perform the insert. A position of 2 will insert the character after the second character (not byte).

    string

    The string that will be inserted into the Seekable

    codec

    The codec to use for determining the location for inserting the string and for encoding the string as bytes

    Definition Classes
    Seekable
  75. def insertIntsAsBytes(position: Long, data: Int*): Any

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes.

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes. In other words just taking the first byte. This is pretty common in Java.io style IO. IE

    outputStream.write(1)

    1 is written as a single byte.

    Definition Classes
    Seekable
  76. def isAbsolute: Boolean

    True is the file is absolute.

    True is the file is absolute. IE is rooted at a filesystem root

    returns

    true if file is absolute.

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#isAbsolute

  77. def isDirectory: Boolean

    True if the path exists and is a directory

    True if the path exists and is a directory

    returns

    true if the path exists and is a directory

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#isDirectory

  78. def isFile: Boolean

    True if the path exists and is a file

    True if the path exists and is a file

    returns

    true if the path exists and is a file

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#isFile

  79. def isFresher(other: Path): Boolean

    True if this path has been modified more recently than other.

    True if this path has been modified more recently than other. If this file does not exist it is not fresh than other

    returns

    True if this path has been modified more recently than other.

    Definition Classes
    Path
  80. def isHidden: Boolean

    True if the file is a hidden file for the current filesystem

    True if the file is a hidden file for the current filesystem

    returns

    True if the file is a hidden file for the current filesystem

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#isHidden()

  81. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  82. def isSame(other: Path): Boolean

    True if this path and the other path reference the same file.

    True if this path and the other path reference the same file.

    This means the two paths may have different segments and perhaps even have symlinks in the path but if they reference the same file then this will return true. Use equals to test if the paths are the same

    returns

    True if this path and the other path reference the same file.

    Definition Classes
    Path
  83. def isSymlink: Boolean

    True if the file is a symlink.

    True if the file is a symlink.

    This method is generally correct but depending the filesystem there is a possibility of getting the the incorrect result since the canonical and absolute paths are compared and no native code is used. Future versions will be guaranteed to work correctly but this version cannot be because of limitations of the VM.

    returns

    True if the file is a symlink.

    Definition Classes
    Path
  84. def iterator: Iterator[Path]

    Definition Classes
    PathPathFinder
  85. val jfile: File

  86. def lastModified: Long

    The time of the last modification of the file

    The time of the last modification of the file

    returns

    the time modified or -1 if not applicable for fileSystem

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#getLastModified()

  87. def lastModified_=(time: Long): Long

    Set the last time modified of the file

    Set the last time modified of the file

    returns

    the new time

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#setLastModified(Long)

  88. def lines(terminator: Terminator = Terminators.Auto, includeTerminator: Boolean = false)(implicit codec: Codec = Codec.default): LongTraversable[String]

    Obtain an non-strict traversable for iterating through the lines in the object

    Obtain an non-strict traversable for iterating through the lines in the object

    If the codec is not the same as the source codec (the codec of the underlying data) then the characters will converted to the desired codec.

    terminator

    The strategy for determining the end of line Default is to auto-detect the EOL

    includeTerminator

    if true then the line will end with the line terminator Default is false

    codec

    The codec representing the desired encoding of the characters

    returns

    a non-strict traversable for iterating through all the lines

    Definition Classes
    Input
  89. def matcher(pattern: String, syntax: String = PathMatcher.StandardSyntax.GLOB): PathMatcher[Path]

    Create a matcher from this path's filesystem

    Create a matcher from this path's filesystem

    Definition Classes
    Path
    See also

    FileSystem # matcher ( String, String )

  90. def moveDirectory(target: Path, atomicMove: Boolean): Unit

    Called to move the current directory to another location on the same filesystem

    Called to move the current directory to another location on the same filesystem

    Attributes
    protected
    Definition Classes
    DefaultPathPath
  91. def moveFile(target: Path, atomicMove: Boolean): Unit

    Called to move the current file to another location on the same filesystem

    Called to move the current file to another location on the same filesystem

    Attributes
    protected
    Definition Classes
    DefaultPathPath
  92. def moveTo[P <: Path](target: P, replace: Boolean, atomicMove: Boolean): P

    Move the underlying object if it exists to the target location.

    Move the underlying object if it exists to the target location.

    If copying of the file is required this will happen, as long as atomicMove = false. If atomicMove = true and the move requires copy then deletion an exception will be thrown. This is filesystem dependent

    target

    the target path to move the filesystem object to.

    replace

    if true then replace any existing target object unless it is a non-empty directory in which case an IOException is thrown. False by default

    atomicMove

    it will guarantee atomicity of the move False by default

    returns

    true the path to the moved object

    Definition Classes
    Path
    Exceptions thrown
    IOException

    if the move could not be satisfied because the target could not be written to or if this path cannot be moved

  93. def name: String

    The name of the file.

    The name of the file. This includes the extension of the file

    returns

    the name of the file

    Definition Classes
    DefaultPathPath
  94. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  95. def nonExistent: Boolean

    False if the path does not exist in the file system

    False if the path does not exist in the file system

    returns

    false if the path does not exist in the file system

    Definition Classes
    DefaultPathPath
  96. lazy val normalize: PathType

    Returns the related Path that starts at a root of the file system and is the direct path with all relative segments are resolved.

    Returns the related Path that starts at a root of the file system and is the direct path with all relative segments are resolved.

    For example /home/user/../another is not a valid normalized path.

    Definition Classes
    Path
    See also

    java.file.File#toCanonical

    #toAbsolute

  97. final def notify(): Unit

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

    Definition Classes
    AnyRef
  99. def outputProcessor: OutputProcessor

    Execute the function 'f' passing an Output instance that performs all operations on a single opened connection to the underlying resource.

    Execute the function 'f' passing an Output instance that performs all operations on a single opened connection to the underlying resource. Typically each call to one of the Output's methods results in a new connection. For example if the underlying OutputStream truncates the file each time the connection is made then calling write two times will result in the contents of the second write overwriting the second write.

    Even if the underlying resource is an appending, using open will be more efficient since the connection only needs to be made a single time.

    returns

    the result of the function

    Definition Classes
    Output
  100. def outputStream(openOptions: OpenOption*): OutputStreamResource[FileOutputStream]

    Definition Classes
    DefaultFileOps
  101. def parent: Option[DefaultPath]

    The parent path segment if it is possible (for example a root will not have a parent)

    The parent path segment if it is possible (for example a root will not have a parent)

    returns

    the parent path segment if it possible

    Definition Classes
    DefaultPathPath
    See also

    parents

  102. lazy val parents: Seq[Path]

    The path segments of the path excluding the current path segment.

    The path segments of the path excluding the current path segment. The first segment is the first segment in the path.

    returns

    The path segments of the path excluding the current path segment

    Definition Classes
    Path
    See also

    segments

  103. def patch[T](position: Long, data: T, overwrite: Overwrite)(implicit converter: OutputConverter[T]): Unit

    Update a portion of the file content at the declared location.

    Update a portion of the file content at the declared location. This is the most flexible of the random access methods but is also (probably) the trickiest to fully understand. That said it behaves (almost) identical to a scala.collection.Seq.patch method, so if you understand that you should not have difficulty understanding this method.

    Important: The use of an Array is highly recommended because normally arrays can be more efficiently written using the underlying APIs

    To append data the position must >= size

    If the position is within the file but the position + bytes.length is beyond the end of the file the file will be enlarged so that the entire string can fit in the file

    The write begins at the position indicated. So if position = 0 then the write will begin at the first byte of the file.

    position

    The start position of the update starting at 0. The position must be within the file or == size (for appending)

    data

    The data to write. This can be any type that has a scalax.io.OutputConverter associated with it. There are predefined $outputConverters for several types. See the scalax.io.OutputConverter object for the predefined types and for objects to simplify implementing custom scalax.io.OutputConverter

    overwrite

    The strategy that dictates how many characters/bytes/units are overwritten $converterParam

    Definition Classes
    Seekable
  104. def patch(position: Long, string: String, overwrite: Overwrite)(implicit codec: Codec = Codec.default): Unit

    Update a portion of the file content at the declared location.

    Update a portion of the file content at the declared location. This is the most flexible of the random access methods but is also (probably) the trickiest to fully understand. That said it behaves (almost) identical to a scala.collection.Seq.patch method, so if you understand that you should not have difficulty understanding this method.

    If the position is beyond the end of the file a BufferUnderflow Exception will be thrown

    If the position is within the file but the position + string.getBytes(codec).length is beyond the end of the file the file will be enlarged so that the entire string can fit in the file

    The write begins at the position indicated. So if position = 0 then the write will begin at the first byte of the file.

    position

    The start position of the update starting at 0. The position is the position'th character in the file using the codec for decoding the file The position must be within the file.

    string

    The string to write to the file starting at position.

    overwrite

    The strategy that dictates how many characters/bytes/units are overwritten

    codec

    The codec to use for decoding the underlying data into characters

    Definition Classes
    Seekable
  105. def patchIntsAsBytes(position: Long, overwrite: Overwrite, data: Int*): Unit

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes.

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes. In other words just taking the first byte. This is pretty common in Java.io style IO. IE

    outputStream.write(1)

    1 is written as a single byte.

    Definition Classes
    Seekable
  106. def path: String

    The path of the file.

    The path of the file. It may or may not be relative

    returns

    the path of the file

    Definition Classes
    DefaultPathPath
  107. def readWriteChannel[U](f: (SeekableByteChannel) ⇒ U): U

    Attributes
    protected
    Definition Classes
    Seekable
  108. def relativize(other: Path): Path

    Make the current path relative to the other path.

    Make the current path relative to the other path. If the two paths are on different drives then the other path is returned. If the two paths have different roots the other path is returned. If the two paths reference the same path then the other path is returned

    returns

    relative path from the current path to the other path

    Definition Classes
    Path
  109. def resolve(pathSegments: String*): PathType

    Constructs a path from other using the same file system as this path and resolves the this and other in the same manner as Path#resolve(Path)

    Constructs a path from other using the same file system as this path and resolves the this and other in the same manner as Path#resolve(Path)

    Examples:

    path resolve ("a/b/c",'/') // result is Path / a / b / c
    path resolve ("//..//b//",'/') // result is Path / .. / b
    pathSegments

    the path segments that make up the path

    returns

    a path resolved as a child of this

    Definition Classes
    Path
  110. def resolve(other: String, separator: Char): PathType

    Constructs a path from other using the same file system as this path and resolves the this and other in the same manner as Path#resolve(Path)

    Constructs a path from other using the same file system as this path and resolves the this and other in the same manner as Path#resolve(Path)

    Examples:

    path resolve ("a/b/c",'/') // result is Path / a / b / c
    path resolve ("//..//b//",'/') // result is Path / .. / b
    other

    the string representation of the path with segment separators as indicated by separator

    separator

    the separator character used in other

    returns

    a path resolved as a child of this

    Definition Classes
    Path
  111. def resolve(other: Path): PathType

    Resolve this path with other.

    Resolve this path with other. In the simplest case that means appending other to this.

    Does the same thing as the / method

    other

    another path to append to this path

    returns

    the constructed/resolved path

    Definition Classes
    Path
  112. lazy val root: Option[PathType]

    The root of the file system of the path if it can be determined.

    The root of the file system of the path if it can be determined.

    returns

    the root of the file system

    Definition Classes
    Path
  113. def seekableProcessor(openOptions: Seq[OpenOption] = List(Read,Write), context: ResourceContext = fileSystem.context): SeekableProcessor

    Runs several operations as efficiently as possible.

    Runs several operations as efficiently as possible. If the filesystem permits random access then the same channel will be used to perform all operations.

    Note: only the direct file operations (bytes,lines,write,patch etc...) can be used and expected to use the same resource. The resource methods all created new streams.

    Note: not all file systems support this, if not then at worst the performance is the same as if they where performed outside an open block

    openOptions

    The options that define how the file is opened for the duration of the operation Default is Write/Create/Truncate

    context

    The context for controlling buffer sizes error handling and other low level configuration defaults to filesystem Resource context

    Definition Classes
    FileOps
  114. def seekableProcessor: SeekableProcessor

    Definition Classes
    Seekable
  115. lazy val segments: Seq[String]

    Definition Classes
    DefaultPathPath
  116. val separator: String

    The path segment separator string for the filesystem

    The path segment separator string for the filesystem

    Definition Classes
    Path
    See also

    FileSystem#separator

  117. def sibling(pathSegments: String*): PathType

    Resolves other against this path's parent in the same manner as sibling(Path)

    Resolves other against this path's parent in the same manner as sibling(Path)

    pathSegments

    the path from parent to the sibling.

    returns

    a path resolved as a child of parent or other if there is no parent

    Definition Classes
    Path
  118. def sibling(other: String, separator: Char): PathType

    Resolves other against this path's parent in the same manner as sibling(Path)

    Resolves other against this path's parent in the same manner as sibling(Path)

    other

    the path from parent to the sibling.

    separator

    the separator character that is used in other

    returns

    a path resolved as a child of parent or other if there is no parent

    Definition Classes
    Path
  119. def sibling(other: Path): PathType

    Resolves other against this path's parent in the same manner as in resolve(Path).

    Resolves other against this path's parent in the same manner as in resolve(Path).

    If parent does not exist fileSystem.fromSeq(other.segments) will be returned. Otherwise parent.resolve(other) will be returned

    other

    the path from parent to the sibling.

    returns

    a path resolved as a child of parent or None if parent is None

    Definition Classes
    Path
  120. def simpleName: String

    The name of the file excluding of the file

    The name of the file excluding of the file

    returns

    name of the file excluding of the file

    Definition Classes
    Path
  121. def size: Option[Long]

    The size of the file/directory in bytes

    The size of the file/directory in bytes

    returns

    The size of the file/directory in bytes

    Definition Classes
    DefaultPathPathInput
    See also

    java.file.File#length()

  122. def startsWith(other: Path): Boolean

    True if this path starts with the other path

    True if this path starts with the other path

    returns

    True if this path starts with the other path

    Definition Classes
    Path
  123. def string(implicit codec: Codec = Codec.default): String

    Loads all the characters into memory.

    Loads all the characters into memory. There is no protection against loading very large files/amounts of data.

    codec

    The codec representing the desired encoding of the characters

    Definition Classes
    Input
  124. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  125. def tempFile(): Path

    Create a temporary file to use for performing certain operations.

    Create a temporary file to use for performing certain operations. It should be as efficient as possible to copy from the temporary file to this Seekable and vice-versa. Can be overridden for performance

    Attributes
    protected
    Definition Classes
    PathSeekable
  126. def toAbsolute: DefaultPath

    Modifies the Path so that it is absolute from a root of the file system.

    Modifies the Path so that it is absolute from a root of the file system. However it is not necessarily canonical. For example /home/user/../another is a valid absolute path.

    Definition Classes
    DefaultPathPath
    See also

    normalize

  127. def toByteChannelResource(): InputResource[ByteChannel]

    Open a seekableByteChannelResource to use for creating other long traversables like chars or bytes as its.

    Open a seekableByteChannelResource to use for creating other long traversables like chars or bytes as its.

    This method may throw an exception if the file does not exist

    Main feature is it sets position to 0 each call so the resource will always read from 0

    Attributes
    protected
    Definition Classes
    FileOpsSeekable
  128. def toRealPath(linkOptions: LinkOption*): DefaultPath

    The true/real representation of the current path.

    The true/real representation of the current path.

    The full and true path of this path will be resolved, links will be handled according to the link options . and .. etc... will be resolved and if this path is relative it will be made absolute.

    If no linkOptions are supplied this method will follow links

    linkOptions

    How to handle link options

    returns

    the real path

    Definition Classes
    DefaultPathPath
    Note

    in Java 6 linkOptions are ignored because only Java.io.File apis are used but in Java 7 linkOptions are correctly handled

  129. def toString(): String

    Definition Classes
    DefaultPathPath → AnyRef → Any
  130. def toURI: URI

    Creates a URI from the path.

    Creates a URI from the path.

    Definition Classes
    DefaultPathPath
    See also

    java.file.File#toURI

  131. def toURL: URL

    Creates a URL from the path.

    Creates a URL from the path. This does have the bug present in java.file.File#toURL and can be used directly.

    Definition Classes
    Path
    See also

    java.file.File#toURI

  132. def truncate(position: Long): Unit

    Truncate/Chop the Seekable to the number of bytes declared by the position param

    Truncate/Chop the Seekable to the number of bytes declared by the position param

    Definition Classes
    Seekable
  133. def truncateString(position: Long)(implicit codec: Codec = Codec.default): Unit

    Definition Classes
    Seekable
  134. def underlyingChannel(append: Boolean): OpenedResource[SeekableByteChannel]

    Attributes
    protected
    Definition Classes
    FileOpsSeekable
  135. def underlyingOutput: OutputResource[WritableByteChannel]

    Attributes
    protected
    Definition Classes
    FileOpsSeekableOutput
  136. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  139. def withLock[R](start: Long = 0, size: Long = 1, shared: Boolean = false, context: ResourceContext)(block: (Seekable) ⇒ R): Option[R]

    Definition Classes
    DefaultFileOps
  140. def write(string: String)(implicit codec: Codec = Codec.default): Unit

    Writes a string.

    Writes a string.

    string

    the data to write

    codec

    the codec of the string to be written. The string will be converted to the encoding of sourceCodec Default is sourceCodec

    Definition Classes
    Output
  141. def write[T](data: T)(implicit writer: OutputConverter[T]): Unit

    Write data to the underlying object.

    Write data to the underlying object. Each time write is called the resource is reopened, in the case of a file this means that the file will be opened and truncated. The

    In the case of writing ints and bytes it is often recommended to write arrays of data since normally the underlying object can write arrays of bytes or integers most efficiently.

    Since Characters require a codec to write to an OutputStream characters cannot be written with this method unless a OutputWriterFunction.CharFunction object is provided as the writer.

    data

    The data to write to underlying object. Any data that has a resolvable scalax.io.OutputConverter can be written. See the scalax.io.OutputConverter object for the defined scalax.io.OutputConverter implementations and classes to assist implementing more.

    writer

    The strategy used to write the data to the underlying object. Many standard data-types are implicitly resolved and do not need to be supplied

    Definition Classes
    Output
    See also

    #writeChars for more on writing characters

  142. def writeChars(characters: TraversableOnce[Char])(implicit codec: Codec = Codec.default): Unit

    Definition Classes
    Output
  143. def writeIntsAsBytes(data: Int*): Unit

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes.

    Since the scalax.io.OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes. In other words just taking the first byte. This is pretty common in Java.io style IO. IE

    outputStream.write(1)

    1 is written as a single byte.

    Definition Classes
    Output
  144. def writeStrings(strings: Traversable[String], separator: String = "")(implicit codec: Codec = Codec.default): Unit

    Write several strings.

    Write several strings.

    strings

    The data to write

    separator

    A string to add between each string. It is not added to the before the first string or after the last.

    codec

    The codec of the strings to be written. The strings will be converted to the encoding of sourceCodec

    Definition Classes
    Output

Inherited from DefaultFileOps

Inherited from Path

Inherited from Ordered[Path]

Inherited from Comparable[Path]

Inherited from PathFinder[Path]

Inherited from FileOps

Inherited from Seekable

Inherited from Output

Inherited from Input

Inherited from AnyRef

Inherited from Any

Ungrouped