Trait/Object

com.thoughtworks.feature

ByName

Related Docs: object ByName | package feature

Permalink

trait ByName[ByNameType] extends Serializable

A type class for convert between by-name type and normal by-value type.

Installation

libraryDependencies += "com.thoughtworks.feature" %% "byname" % "latest.release"

This ByName type class provide an extension method extract for ByName.=> types via implicit view, which can be import as follow:

import com.thoughtworks.feature.ByName.ops._
Author:

杨博 (Yang Bo) <[email protected]>

ByNameType

The by-name type

Annotations
@implicitNotFound( ... )
Source
ByName.scala
Note

When using this ByName type class, you should make sure the type parameter ByNameType is an abstract type, in case of Scala compiler bugs. You can use a trick similar to C++'s Pimpl Idiom to create opacity abstract types

import com.thoughtworks.feature.ByName.`=>`
trait OpacityTypes {
  type IntByName
  implicit def typeClass: ByName.Aux[IntByName, Int]
}
val opacityTypes: OpacityTypes = new OpacityTypes {
  type IntByName = `=>`[Int]
  override def typeClass = ByName[IntByName]
}
import opacityTypes._

Now IntByName is an abstract type with underlying => Int type.


Given a by-name parameter of the return value of getInt(),

val getInt = stubFunction[Int]
val boxedByName: IntByName = typeClass.make(getInt())

when getInt returns 42,

getInt.when.once returns 42

then the value of the the by-name parameter should be 42;

boxedByName.extract should be(42)

when getInt returns 144,

getInt.when.once returns 144

then the value of the the by-name parameter should be 144.

boxedByName.extract should be(144)
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ByName
  2. Serializable
  3. Serializable
  4. AnyRef
  5. 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

Type Members

  1. abstract type Value

    Permalink

Abstract Value Members

  1. abstract def extract(byName: ByNameType): Value

    Permalink
  2. abstract def make(byName: ⇒ Value): ByNameType

    Permalink

    Creates a by-name parameter.

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 ByName[ByNameType] to any2stringadd[ByName[ByNameType]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ByName[ByNameType], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ByName[ByNameType] to ArrowAssoc[ByName[ByNameType]] 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: (ByName[ByNameType]) ⇒ Boolean, msg: ⇒ Any): ByName[ByNameType]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ByName[ByNameType] to Ensuring[ByName[ByNameType]] 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 ByName[ByNameType] to StringFormat[ByName[ByNameType]] 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): (ByName[ByNameType], B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ByName[ByNameType] to any2stringadd[ByName[ByNameType]]

Inherited by implicit conversion StringFormat from ByName[ByNameType] to StringFormat[ByName[ByNameType]]

Inherited by implicit conversion Ensuring from ByName[ByNameType] to Ensuring[ByName[ByNameType]]

Inherited by implicit conversion ArrowAssoc from ByName[ByNameType] to ArrowAssoc[ByName[ByNameType]]

Ungrouped