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

trait File[ID] extends Element[ID]

A trait representing a file stored on a server.

The trait allows access to metadata properties of the file. The actual content of the file can be downloaded via the FileSystem API.

ID

the type of the ID of a file

Linear Supertypes
Element[ID], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. File
  2. Element
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def createdAt: Instant

    Returns the date when this element has been created.

    Returns the date when this element has been created.

    returns

    the creation date of this element

    Definition Classes
    Element
  2. abstract def description: Option[String]

    Returns the description of this element.

    Returns the description of this element. Not all file systems support such a description, and users typically do not provide one; therefore, this is an Option and can be None.

    returns

    the optional description of this element

    Definition Classes
    Element
  3. abstract def id: ID

    Returns the ID of this element.

    Returns the ID of this element. Via this ID the element can be resolved, e.g. to obtain its metadata or download it (if possible).

    returns

    the ID of this element

    Definition Classes
    Element
  4. abstract def lastModifiedAt: Instant

    Returns the date of the last modification of this element.

    Returns the date of the last modification of this element.

    returns

    the date of last modification

    Definition Classes
    Element
  5. abstract def name: String

    Returns the name of this element.

    Returns the name of this element. The name is typically displayed to the end user to identify this element.

    returns

    the name of this element

    Definition Classes
    Element
  6. abstract def size: Long

    Returns the size of the content of this file.

    Returns the size of the content of this file.

    returns

    the file size

Concrete 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. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. 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 Element[ID]

Inherited from AnyRef

Inherited from Any

Ungrouped