Trait

ch.waan.mcddpui.api

Record

Related Doc: package api

Permalink

trait Record[T] extends AnyRef

a record encapsulates an immutable data structure in a modifiable container with a modification history and undo/redo functionality

T

the type of the encapsulated data structure

Version

1.2 (0.2.0), 2016-03-02

Since

MCDDPUI 0.1.0

Note

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

Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Record
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def listRedoPaths: List[String]

    Permalink

    lists all possible redo paths in order

    lists all possible redo paths in order

    returns

    a list containing the names for all possible redo paths

  2. abstract def redo(index: Int): Unit

    Permalink

    redoes the along a given path

    redoes the along a given path

    index

    the index of the redo path

    Annotations
    @throws( ... ) @throws( ... )
    Exceptions thrown

    IndexOutOfBoundsException if the redo path index is out of bounds

    RecordHistoryManipulationException if the redo failed

  3. abstract def undo: Unit

    Permalink

    undoes the last modification

    undoes the last modification

    Annotations
    @throws( ... )
    Exceptions thrown

    RecordHistoryManipulationException if the undo failed

  4. abstract def update(c: MutationCommand[_ >: T, _ <: T]): Unit

    Permalink

    updates the internal data structure through the MutationCommand

    updates the internal data structure through the MutationCommand

    c

    the command to update the data structure with

    Annotations
    @throws( ... )
    Exceptions thrown

    Throwable if any exceptional condition occurs during command execution

  5. abstract def view(c: ReadCommand[_ >: T]): Unit

    Permalink

    passes the internal data structure to the ReadCommand

    passes the internal data structure to the ReadCommand

    c

    the command to execute

    Annotations
    @throws( ... )
    Exceptions thrown

    Throwable if any exceptional condition occurs during command execution

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to any2stringadd[Record[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Record[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to ArrowAssoc[Record[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Record[T]) ⇒ Boolean, msg: ⇒ Any): Record[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to Ensuring[Record[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Record[T]) ⇒ Boolean): Record[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to Ensuring[Record[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Record[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to Ensuring[Record[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Record[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to Ensuring[Record[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to StringFormat[Record[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Record[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Record[T] to ArrowAssoc[Record[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Record[T] to any2stringadd[Record[T]]

Inherited by implicit conversion StringFormat from Record[T] to StringFormat[Record[T]]

Inherited by implicit conversion Ensuring from Record[T] to Ensuring[Record[T]]

Inherited by implicit conversion ArrowAssoc from Record[T] to ArrowAssoc[Record[T]]

Ungrouped