Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package github
    Definition Classes
    com
  • package cloudfiles
    Definition Classes
    github
  • package core
    Definition Classes
    cloudfiles
  • object Model

    A module defining basic types to represent files and folders in a cloud storage.

    A module defining basic types to represent files and folders in a cloud storage.

    The data types introduced by this module define a minimum set of properties that should be common to all concrete implementations of cloud storages. They can be extended by specific implementations to add more properties that are supported by this platform.

    Note that a concrete implementation of the FileSystem trait is free to use these data types or not. (The trait itself is agnostic about the concrete types in use.) However, supporting these types simplifies operations between different server types.

    Definition Classes
    core
  • Element
  • File
  • Folder
  • FolderContent

case class FolderContent[ID, FILE, FOLDER](folderID: ID, files: Map[ID, FILE], folders: Map[ID, FOLDER]) extends Product with Serializable

A data class that stores the content of a specific folder.

An instances contains the (sub) folders and files contained in the represented folder. They are organized in maps, so that they can be accessed directly by their IDs.

ID

the type to represent an ID

FILE

the type to represent a file

FOLDER

the type to represent a folder

folderID

the ID of the represented folder

files

a map with the files contained in this folder

folders

a map with the sub folders of this folder

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FolderContent
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FolderContent(folderID: ID, files: Map[ID, FILE], folders: Map[ID, FOLDER])

    folderID

    the ID of the represented folder

    files

    a map with the files contained in this folder

    folders

    a map with the sub folders of this folder

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val files: Map[ID, FILE]
  8. val folderID: ID
  9. val folders: Map[ID, FOLDER]
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mapContent(mapFiles: Option[(FILE) => FILE] = None, mapFolders: Option[(FOLDER) => FOLDER] = None): FolderContent[ID, FILE, FOLDER]

    Applies mappings to the content stored in this object.

    Applies mappings to the content stored in this object. The mapping functions that are defined are invoked on the files and folders, and a new instance is created with the results. Note: The mapping functions must not change the IDs of elements.

    mapFiles

    optional mapping function on files

    mapFolders

    optional mapping function on folders

    returns

    the result of the mapping

  13. def mapContentParallel(mapFiles: Option[(FILE) => FILE] = None, mapFolders: Option[(FOLDER) => FOLDER] = None)(implicit ec: ExecutionContext): Future[FolderContent[ID, FILE, FOLDER]]

    Applies mappings in parallel to the content stored in this object.

    Applies mappings in parallel to the content stored in this object. This function is analogous to mapContent(), but invocations to mapping functions are wrapped in Future objects, and therefore run concurrently. The resulting future completes when all mappings are done.

    mapFiles

    optional mapping function on files

    mapFolders

    optional mapping function on folders

    ec

    the execution context

    returns

    a Future with the result of the mapping

  14. def mapContentParallelTried(mapFiles: Option[(FILE) => Try[FILE]] = None, mapFolders: Option[(FOLDER) => Try[FOLDER]] = None)(implicit ec: ExecutionContext): Future[(FolderContent[ID, FILE, FOLDER], List[Failure[ID]])]

    Applies mappings in parallel to the content stored in this object that can fail.

    Applies mappings in parallel to the content stored in this object that can fail. This function is analogous to mapContentParallel(), but the passed in mapping functions return a Try. Result is a Future with a tuple that contains a FolderContent object with all the files and folders that could be mapped successfully, and a list with failures that occurred during mapping.

    mapFiles

    optional mapping function on files

    mapFolders

    optional mapping function on folders

    ec

    the execution context

    returns

    a Future with the results of the mapping

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped