Class

com.seancheatham.storage

DocumentStorage

Related Doc: package storage

Permalink

abstract class DocumentStorage[T] extends AnyRef

An interface for storing JSON-like documents

T

A readable/writable data type, such as a Json Value

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentStorage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentStorage()

    Permalink

Abstract Value Members

  1. abstract def append(key: String*)(value: T)(implicit ec: ExecutionContext): Future[String]

    Permalink

    Append the given value to the array located in the given bucket at the given key.

    Append the given value to the array located in the given bucket at the given key.

    key

    The key path to the item

    value

    The value to append

    returns

    A Future containing either the ID or index of the appended item

  2. abstract def delete(key: String*)(implicit ec: ExecutionContext): Future[_]

    Permalink

    Delete the value located in the bucket at the given key path

    Delete the value located in the bucket at the given key path

    key

    The key path to the item

    returns

    A Future

  3. abstract def get(key: String*)(implicit ec: ExecutionContext): Future[T]

    Permalink

    Fetch the value located in the bucket at the given key path

    Fetch the value located in the bucket at the given key path

    key

    The key path to the item

    returns

    A Future value, failed by NoSuchElementException if the value does not exist

  4. abstract def getCollection(key: String*)(implicit ec: ExecutionContext): Future[Iterator[T]]

    Permalink

    A specialized version of scala.concurrent.ExecutionContext) which fetches an array value as an Iterator

    A specialized version of scala.concurrent.ExecutionContext) which fetches an array value as an Iterator

    key

    The key path to the item

    returns

    A Future Iterator of values, or an empty iterator if the value does not exist

  5. abstract def merge(key: String*)(value: T)(implicit ec: ExecutionContext): Future[_]

    Permalink

    Merge the given value into the given key path.

    Merge the given value into the given key path. A merge is performed by traversing into object paths, and overwriting terminal node values. However, any nodes which aren't touched remain as they were.

    key

    The key path to the item

    value

    The value to write

    returns

    A Future

  6. abstract def write(key: String*)(value: T)(implicit ec: ExecutionContext): Future[_]

    Permalink

    Write (overwriting if anything exists there already) the given value to the given key path located in the given bucket

    Write (overwriting if anything exists there already) the given value to the given key path located in the given bucket

    key

    The key path to the item

    value

    The value to write

    returns

    A Future

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getOpt(key: String*)(implicit ec: ExecutionContext): Future[Option[T]]

    Permalink

    Fetches the value located in the bucket at the given key path, if it exists.

    Fetches the value located in the bucket at the given key path, if it exists. In other words, lifts scala.concurrent.ExecutionContext) to an Option[T]

    key

    The key path to the item

    returns

    A Future Optional value

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped