org.scalaequals

ScalaEqualsExtend

object ScalaEqualsExtend

Entry point for custom ScalaEquals macros. Functions here are not guaranteed to produce correct equals/hashCode implementations if used incorrectly. See individual function documentation for additional details.

Version

1.2.0

Since

1.2.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaEqualsExtend
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equal(param: Any, params: Any*): Boolean

    Equality check using only parameters passed in to test for equality.

    Equality check using only parameters passed in to test for equality.

    Acceptable arguments include private/protected/public vals, vars, lazy vals, and defs with no arguments. Do note that it is possible the implementation created by this macro will be inconsistent with the equals/hashCode contract if you use vars or defs where the value changes. Use this function only if you know what you are doing, and proceed with caution.

    param

    first param to test with

    params

    rest of the params

    returns

    true if instance.equals(other)

    Annotations
    @macroImpl()
  10. def equalAllValsNoCompareTo: Boolean

    Equality check using all private/protected/public/lazy vals of the class defined in the constructor AND the body of the class.

    Equality check using all private/protected/public/lazy vals of the class defined in the constructor AND the body of the class. Does not use inherited or overriden vals. Does NOT use compareTo for Float and Double values

    returns

    true if instance.equals(other)

    Annotations
    @macroImpl()
  11. def equalNoCompareTo(param: Any, params: Any*): Boolean

    Equality check using only parameters passed in to test for equality.

    Equality check using only parameters passed in to test for equality.

    Acceptable arguments include private/protected/public vals, vars, lazy vals, and defs with no arguments. Does NOT use compareTo for Float and Double values

    param

    first param to test with

    params

    rest of the params

    returns

    true if instance.equals(other)

    Annotations
    @macroImpl()
  12. def equalNoCompareTo: Boolean

    Equality check using all private/protected/public vals of the class defined in the constructor.

    Equality check using all private/protected/public vals of the class defined in the constructor. Does not use inherited or overriden vals. Do not use with traits, it will only generate a super.equals(that) call, instead use equalAllVals. Does NOT use compareTo for Float and Double values

    returns

    true if instance.equals(other)

    Annotations
    @macroImpl()
  13. def equals(arg0: Any): Boolean

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. def hash(hashFunction: (Array[Any]) ⇒ Int): Int

    Looks up the elements tested in equals (including super.equals) and uses them in hashFunction(Array(elements)).

    Looks up the elements tested in equals (including super.equals) and uses them in hashFunction(Array(elements)). Works with all 3 forms of equal. Does not work with custom equals implementations, one of ScalaEquals.equal, ScalaEquals.equal(params), or ScalaEquals.equalAllVals must be used (or their compareTo equivalents). Use this function only if you know what you are doing, and proceed with caution.

    hashFunction

    to use to produce a hashCode for the elements used in equals

    returns

    hashCode generated from fields used in equals

    Annotations
    @macroImpl()
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  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
  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  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()

Inherited from AnyRef

Inherited from Any

Ungrouped