FileIO

Type Members

type FileStatistics = jni.FileStatistics
sealed trait Mode extends AnyRef

Mode in which to open a file.
sealed trait Whence extends AnyRef

Used to represent the position reference for calls to seek.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
object APPEND extends Mode with Product with Serializable

Open file for appending.
Open file for appending. The file pointer will be at the end of the file if the file exists. That is, the file is in the append mode. If the file does not exist, a new file is created for writing.
object CURRENT_POSITION extends Whence with Product with Serializable
object END_OF_FILE extends Whence with Product with Serializable
val FileStatistics: jni.FileStatistics.type
object READ extends Mode with Product with Serializable

Open file for reading.
Open file for reading. The file pointer will be at the beginning of the file.
object READ_APPEND extends Mode with Product with Serializable

Open file for both reading and appending.
Open file for both reading and appending. The file pointer will be at the end of the file if the file exists. That is, the file is in the append mode. If the file does not exist, a new file is created for writing.
object READ_WRITE extends Mode with Product with Serializable

Open file for both reading and writing.
Open file for both reading and writing. The file pointer will be at the beginning of the file.
object READ_WRITE_TRUNCATE extends Mode with Product with Serializable

Open file for both reading and writing.
Open file for both reading and writing. Overwrite the file if the file exists. If the file does not exist, creates a new file for writing.
object START_OF_FILE extends Whence with Product with Serializable
object WRITE extends Mode with Product with Serializable

Open file for writing only.
Open file for writing only. Overwrite the file if the file exists. If the file does not exist, creates a new file for writing.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copyFile(oldPath: Path, newPath: Path, overwrite: Boolean = false): Unit

Copies data from the file at oldPath to a new file at newPath.
Copies data from the file at oldPath to a new file at newPath.
oldPath
Old file path.
newPath
New file path.
overwrite
Boolean value indicating whether it is allowed to overwrite the file at newPath, if one already exists.
def deleteFile(filePath: Path): Unit

Deletes the file located at filePath.
Deletes the file located at filePath.
filePath
File path.

def deleteMatchingPaths(path: Path): Unit

Deletes all the matching paths to the path pattern provided.

The pattern must follow the TensorFlow path pattern rules and it pattern must match all of a name (i.e., not just a substring). A pattern definition has the following form:

pattern: { term }
term:
  '*': matches any sequence of non-'/' characters
  '?': matches a single non-'/' character
  '[' [ '^' ] { match-list } ']': matches any single character (not) on the list
  c: matches character c (c != '*', '?', '\\', '[')
  '\\' c: matches character c
character-range:
  c: matches character c (c != '\\', '-', ']')
  '\\' c: matches character c
  lo '-' hi: matches character c for lo <= c <= hi

path: Path pattern.

def deleteRecursively(path: Path): Unit

Deletes everything under the provided path, recursively.
Deletes everything under the provided path, recursively.
path
Path to a file or directory.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def exists(filePath: Path): Boolean

Determines whether a path exists or not.
Determines whether a path exists or not.
filePath
Path to a file or directory.
returns
true if the path exists, whether its a file or a directory, and false if the path does not exist and there are no filesystem errors.
def fileStatistics(path: Path): FileStatistics

Returns file statistics for the provided path.
Returns file statistics for the provided path.
path
Path to a file or directory.
returns
File statistics for the file/directory pointed to by path.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def getLastModifiedTime(path: Path, unit: TimeUnit = TimeUnit.SECONDS, followSymbolicLinks: Boolean = true): Long

Returns a file's last modified time.
Returns a file's last modified time.
path
Path to the file.
unit
Time unit in which to return the last modified time. Defaults to TimeUnit.SECONDS.
followSymbolicLinks
Boolean value indicating whether or not to follow symbolic links. By default, symbolic links are followed and the file attribute of the final target of the link is read. If followSymbolicLinks is set to false, then symbolic links are not followed.

def getMatchingPaths(path: Path, useNativeFileIO: Boolean = true): Set[Path]

Gets all the matching paths to the path pattern provided.

The pattern must follow the TensorFlow path pattern rules and it pattern must match all of a name (i.e., not just a substring). A pattern definition has the following form:

pattern: { term }
term:
  '*': matches any sequence of non-'/' characters
  '?': matches a single non-'/' character
  '[' [ '^' ] { match-list } ']': matches any single character (not) on the list
  c: matches character c (c != '*', '?', '\\', '[')
  '\\' c: matches character c
character-range:
  c: matches character c (c != '\\', '-', ']')
  '\\' c: matches character c
  lo '-' hi: matches character c for lo <= c <= hi

path: Path pattern.
returns: Set of all paths matching the provided path pattern.

def hashCode(): Int

Definition Classes
AnyRef → Any
def isDirectory(path: Path): Boolean

Returns true is path points to a directory, and false otherwise.
Returns true is path points to a directory, and false otherwise.
path
Path to a file or directory.
returns
true is path points to a directory, and false otherwise.
def isGCSPath(path: Path): Boolean

Returns true if path points to a Google Cloud Service (GCS) path.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listDirectories(dirPath: Path): Seq[Path]

Returns all entries contained within the directory at path.
Returns all entries contained within the directory at path. The returned sequence is in arbitrary order and it does not contain the special entries "." and "..".
dirPath
Path to a directory.
returns
Sequence of entries contained in the directory at path.

Annotations
@throws( ... )
Exceptions thrown
NotFoundException If the provided directory does not exist.
def mkDir(path: Path): Unit

Creates a directory at path, but requires that all the parent directories exist.
Creates a directory at path, but requires that all the parent directories exist. If they may not exist, mkDirs() should be used instead. The call is also successful if a directory already exists at path.
path
Directory path.
def mkDirs(path: Path): Unit

Creates a directory at path, along with all necessary parent/intermediate directories.
Creates a directory at path, along with all necessary parent/intermediate directories. The call is also successful if a directory already exists at path.
path
Directory path.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def readFileToString(filePath: Path): String

Reads the entire contents of the file located at filePath to a string and returns it.
def rename(oldPath: Path, newPath: Path, overwrite: Boolean = false): Unit

Rename/move data from the file/directory at oldPath to a new file/directory at newPath.
Rename/move data from the file/directory at oldPath to a new file/directory at newPath.
oldPath
Old path.
newPath
New path.
overwrite
Boolean value indicating whether it is allowed to overwrite the file/directory at newPath, if one already exists.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def walk(dirPath: Path, inOrder: Boolean = true): Stream[(Path, Seq[Path], Seq[Path])]

Walks a directory tree rooted at dirPath recursively.
Walks a directory tree rooted at dirPath recursively.
Note that exceptions that are thrown while listing directories are ignored.
dirPath
Path to a directory from which to start traversing.
inOrder
If true, the top-level directories are returned first, otherwise they are returned last.
returns
Stream over tuples containing: (i) the path for the directory, (ii) a sequence containing all of its subdirectories, and (iii) a sequence containing all files in that directory.
def writeStringToFile(filePath: Path, content: String): Unit

Writes the provided string to the file located at filePath.
def writeStringToFileAtomic(filePath: Path, content: String, overwrite: Boolean = true): Unit

Writes the provided string to the file located at filePath as an atomic operation.
Writes the provided string to the file located at filePath as an atomic operation. This means that when filePath appears in the filesystem, it will contain all of content. With writeStringToFile(), it is possible for the file to appear in the filesystem with content only partially written.
The atomic write is achieved by first writing to a temporary file and then renaming that file.

Related Docs: class FileIO | package io

object FileIO extends Serializable

Type Members

type FileStatistics = jni.FileStatistics

sealed trait Mode extends AnyRef

sealed trait Whence extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object APPEND extends Mode with Product with Serializable

object CURRENT_POSITION extends Whence with Product with Serializable

object END_OF_FILE extends Whence with Product with Serializable

val FileStatistics: jni.FileStatistics.type

object READ extends Mode with Product with Serializable

object READ_APPEND extends Mode with Product with Serializable

object READ_WRITE extends Mode with Product with Serializable

object READ_WRITE_TRUNCATE extends Mode with Product with Serializable

object START_OF_FILE extends Whence with Product with Serializable

object WRITE extends Mode with Product with Serializable

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def copyFile(oldPath: Path, newPath: Path, overwrite: Boolean = false): Unit

def deleteFile(filePath: Path): Unit

def deleteMatchingPaths(path: Path): Unit

def deleteRecursively(path: Path): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(filePath: Path): Boolean

def fileStatistics(path: Path): FileStatistics

def finalize(): Unit

final def getClass(): Class[_]

def getLastModifiedTime(path: Path, unit: TimeUnit = TimeUnit.SECONDS, followSymbolicLinks: Boolean = true): Long

def getMatchingPaths(path: Path, useNativeFileIO: Boolean = true): Set[Path]

def hashCode(): Int

def isDirectory(path: Path): Boolean

def isGCSPath(path: Path): Boolean

final def isInstanceOf[T0]: Boolean

def listDirectories(dirPath: Path): Seq[Path]

def mkDir(path: Path): Unit

def mkDirs(path: Path): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def readFileToString(filePath: Path): String

def rename(oldPath: Path, newPath: Path, overwrite: Boolean = false): Unit

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def walk(dirPath: Path, inOrder: Boolean = true): Stream[(Path, Seq[Path], Seq[Path])]

def writeStringToFile(filePath: Path, content: String): Unit

def writeStringToFileAtomic(filePath: Path, content: String, overwrite: Boolean = true): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped