c

io.scalaland.chimney.dsl

PatcherDefinition

final class PatcherDefinition[From, To, Overrides <: PatcherOverrides, Flags <: PatcherFlags] extends PatcherFlagsDsl[[Flags1]PatcherDefinition[From, To, Overrides, Flags1], Flags]

Allows customization of io.scalaland.chimney.Patcher derivation.

Overrides

type-level encoded config

Flags

type-level encoded flags

Since

0.8.0

Linear Supertypes
PatcherFlagsDsl[[Flags1]PatcherDefinition[From, To, Overrides, Flags1], Flags], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PatcherDefinition
  2. PatcherFlagsDsl
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PatcherDefinition()

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. macro def buildPatcher[ImplicitScopeFlags <: PatcherFlags](implicit tc: PatcherConfiguration[ImplicitScopeFlags]): Patcher[From, To]

    Build Patcher using current configuration.

    Build Patcher using current configuration.

    It runs macro that tries to derive instance of Patcher[From, To]. When transformation can't be derived, it results with compilation error.

    returns

    io.scalaland.chimney.Patcher type class instance

    Since

    0.8.0

  6. def clearOnNoneInPatch: PatcherDefinition[From, To, Overrides, Disable[IgnoreNoneInPatch, Flags]]

    Then there scala.Option is patching scala.Option, on scala.None value will be cleared.

    Then there scala.Option is patching scala.Option, on scala.None value will be cleared.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/supported-patching/#treating-none-as-no-update-instead-of-set-to-none for more details

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def disableMacrosLogging: PatcherDefinition[From, To, Overrides, Disable[MacrosLogging, Flags]]

    Disable printing the logs from the derivation process.

    Disable printing the logs from the derivation process.

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/troubleshooting/#debugging-macros for more details

  9. def enableMacrosLogging: PatcherDefinition[From, To, Overrides, Enable[MacrosLogging, Flags]]

    Enable printing the logs from the derivation process.

    Enable printing the logs from the derivation process.

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/troubleshooting/#debugging-macros for more details

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def failRedundantPatcherFields: PatcherDefinition[From, To, Overrides, Disable[IgnoreRedundantPatcherFields, Flags]]

    Fail the compilation if there is a redundant field in patching object.

    Fail the compilation if there is a redundant field in patching object.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/supported-patching/#ignoring-fields-in-patches for more details

  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def ignoreNoneInPatch: PatcherDefinition[From, To, Overrides, Enable[IgnoreNoneInPatch, Flags]]

    In case when both object to patch and patch value contain field of type scala.Option, this option allows to treat scala.None value in patch as if the value was not provided.

    In case when both object to patch and patch value contain field of type scala.Option, this option allows to treat scala.None value in patch as if the value was not provided.

    By default, when scala.None is delivered in patch, Chimney clears the value of such field on patching.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.4.0

    See also

    https://chimney.readthedocs.io/supported-patching/#treating-none-as-no-update-instead-of-set-to-none for more details

  17. def ignoreRedundantPatcherFields: PatcherDefinition[From, To, Overrides, Enable[IgnoreRedundantPatcherFields, Flags]]

    In case that patch object contains a redundant field (i.e.

    In case that patch object contains a redundant field (i.e. field that is not present in patched object type), this option enables ignoring value of such fields and generate patch successfully.

    By default, when Chimney detects a redundant field in patch object, it fails the compilation in order to prevent silent oversight of field name typos.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.4.0

    See also

    https://chimney.readthedocs.io/supported-patching/#ignoring-fields-in-patches for more details

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from PatcherFlagsDsl[[Flags1]PatcherDefinition[From, To, Overrides, Flags1], Flags]

Inherited from AnyRef

Inherited from Any

Ungrouped