Packages

c

magnolia

CaseClass

abstract class CaseClass[Typeclass[_], Type] extends AnyRef

represents a case class or case object and the context required to construct a new typeclass instance corresponding to it

Instances of CaseClass provide access to all of the parameters of the case class, the full name of the case class type, and a boolean to determine whether the type is a case class or case object.

Typeclass

type constructor for the typeclass being derived

Type

generic type of this parameter

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

Abstract Value Members

  1. abstract def rawConstruct(fieldValues: Seq[Any]): Type

    constructs a new instance of the case class type

    constructs a new instance of the case class type

    Like construct this method is implemented by Magnolia and lets you construct case class instances generically in user code, without knowing their type concretely.

    rawConstruct, however, is more low-level in that it expects you to provide a Seq containing all the field values for the case class type, in order and with the correct types.

    fieldValues

    contains the field values for the case class instance to be constructed, in order and with the correct types.

    returns

    a new instance of the case class

    Exceptions thrown

    IllegalArgumentException if the size of paramValues differs from the size of parameters

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 annotations: Seq[Any]

    a sequence of objects representing all of the annotations on the case class

    a sequence of objects representing all of the annotations on the case class

    For efficiency, this sequence is implemented by an Array, but upcast to a scala.collection.Seq to hide the mutable collection API.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def construct[Return](makeParam: (Param[Typeclass, Type]) ⇒ Return): Type

    constructs a new instance of the case class type

    constructs a new instance of the case class type

    This method will be implemented by the Magnolia macro to make it possible to construct instances of case classes generically in user code, that is, without knowing their type concretely.

    To construct a new case class instance, the method takes a lambda which defines how each parameter in the new case class should be constructed. See the Param class for more information on constructing parameter values from a Param instance.

    makeParam

    lambda for converting a generic Param into the value to be used for this parameter in the construction of a new instance of the case class

    returns

    a new instance of the case class

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val isObject: Boolean
  15. val isValueClass: Boolean
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def parameters: Seq[Param[Typeclass, Type]]

    a sequence of Param objects representing all of the parameters in the case class

    a sequence of Param objects representing all of the parameters in the case class

    For efficiency, this sequence is implemented by an Array, but upcast to a scala.collection.Seq to hide the mutable collection API.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    CaseClass → AnyRef → Any
  22. val typeName: TypeName
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped