Trait

ch.waan.mcddpui.api

ReadCommand

Related Doc: package api

Permalink

trait ReadCommand[T] extends Command

A read command represents a function inspecting a (preferably immutable) data structure without effect in said data structure. A read command may also have side-effects. A read command may result in any arbitrary exception or error. Therefore error handling is necessary at the command execution site. If a read command has side effects the command implementation must ensure a valid (preferably unaffected) state of any (potentially) affected resource.

T

the input type for the command

Annotations
@FunctionalInterface()
Version

1.2, 2016-02-29

Since

MCDDPUI 0.1.0

Note

The implicit conversion methods Implicits.function2readCommand and Implicits.readCommand2function can be used to convert freely between types T => Unit and ReadCommand[T].

,

Immutability of the data structure cannot be enforced. Therefore ensuring immutability (or at least ensuring the lack of any mutating operations on the data structure) lies in the responsibility of the user.

See also

Implicits

Linear Supertypes
Command, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReadCommand
  2. Command
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(t: T): Unit

    Permalink

    The read function for this command.

    The read function for this command.

    t

    the input

    Annotations
    @throws( classOf[Throwable] )
    Exceptions thrown

    Throwable if any exceptional case occurs

    Note

    Immutability of the data structure cannot be enforced. Therefore ensuring immutability (or at least apparent immutability) lies in the responsibility of the user.

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 hashCode(): Int

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

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

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

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

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

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

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

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

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

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

Inherited from Command

Inherited from AnyRef

Inherited from Any

Ungrouped