com.nicta.scoobi.impl.io

Files

Related Docs: object Files | package io

trait Files extends AnyRef

A set of helper functions for implementing DataSources and DataSinks

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

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def checkFilePermissions(path: Path, action: FsAction)(implicit configuration: Configuration): Unit

    check if a READ or WRITE action can be done on a given file based on the current user and on the file permissions

  6. def clone(): AnyRef

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

  7. def copyTo(dir: Path)(implicit configuration: Configuration): (Path) ⇒ Boolean

    returns

    a function copying a Path to a given directory

  8. def copyTo(dir: String)(implicit configuration: Configuration): (Path) ⇒ Boolean

    returns

    a function copying a Path to a given directory

  9. def deletePath(p: Path)(implicit configuration: Configuration): Boolean

    delete the file found at a specific path

  10. def dirPath(s: String): String

    returns

    the path with a trailing slash

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

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def fileStatus(path: Path)(implicit configuration: Configuration): FileStatus

    returns

    the file status of a file

  14. def fileSystem(path: Path)(implicit configuration: Configuration): FileSystem

    returns

    the file system for a given path and configuration

  15. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  17. def getExistingParent(path: Path)(implicit configuration: Configuration): Path

    returns

    the first existing parent for this path

  18. def getFilePermission(path: Path)(implicit configuration: Configuration): FsPermission

    returns

    the permission for a given path

  19. def getSingleFilePerDir(stats: Seq[FileStatus])(implicit configuration: Configuration): Set[Path]

  20. def getSingleFilePerDir(path: Path)(implicit configuration: Configuration): Set[Path]

    Only get one file per dir.

    Only get one file per dir. This helps when checking correctness of input data by reducing the number of files to check. We don't want to check every file as its expensive

  21. def globStatus(path: Path, pathFilter: PathFilter = hiddenFilePathFilter)(implicit configuration: Configuration): Seq[FileStatus]

    Get a Set of FileStatus objects for a given Path specified as a glob

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. def isDirectory(path: Path)(implicit configuration: Configuration): Boolean

    returns

    true if the path is a directory

  24. def isDirectory(fileStatus: FileStatus): Boolean

    returns

    true if the file is a directory

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def moveTo(dir: Path)(implicit configuration: Configuration): (Path, Path) ⇒ Boolean

    returns

    a function moving a Path to a given directory

  27. def moveTo(dir: String)(implicit configuration: Configuration): (Path) ⇒ Boolean

    returns

    a function moving a Path to a given directory

  28. def moveToS3(from: FileSystem, to: FileSystem, path: Path, destPath: Path)(implicit configuration: Configuration): Boolean

    returns

    true if copy to S3 is successful. S3 is a special cases because it can't rename, can't copy/rename dir simultaneously, ...

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

    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  32. def pathExists(p: String)(implicit configuration: Configuration): Boolean

    Determine whether a path exists or not.

  33. def pathExists(p: Path, pathFilter: PathFilter = hiddenFilePathFilter)(implicit configuration: Configuration): Boolean

    Determine whether a path exists or not.

  34. def pathSize(p: Path)(implicit configuration: Configuration): Long

    Determine the byte size of data specified by a path.

  35. def sameFileSystem(from: FileSystem, to: FileSystem): Boolean

    returns

    true if the 2 fileSystems are the same

  36. def sizeString(bytes: Long): String

    Provide a nicely formatted string for a byte size.

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

    Definition Classes
    AnyRef

  38. def toString(): String

    Definition Classes
    AnyRef → Any

  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def fileStatus(path: Path, pathFilter: PathFilter = hiddenFilePathFilter)(implicit configuration: Configuration): Seq[FileStatus]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.3) use globStatus instead

Inherited from AnyRef

Inherited from Any

Ungrouped