Class whose instances represent an invocation of a private method
Class used via an implicit conversion to enable private methods to be tested
Represent a private method, whose apply method returns an Invocation
object that
records the name of the private method to invoke, and any arguments to pass to it when invoked
Contains a factory method for instantiating PrivateMethod
objects
Implicit conversion from AnyRef
to Invoker
, used to enable
assertions testing of private methods
Implicit conversion from AnyRef
to Invoker
, used to enable
assertions testing of private methods.
the target object on which to invoke a private method.
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence.
The default implementations of this method is an equivalence relation:
x
of type Any
,
x.equals(x)
should return true
.x
and y
of type
Any
, x.equals(y)
should return true
if and only
if y.equals(x)
returns true
.x
, y
, and z
of type AnyRef
if x.equals(y)
returns true
and
y.equals(z)
returns
true
, then x.equals(z)
should return true
.
If you override this method, you should verify that
your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to
override hashCode
to ensure that objects that are
"equal" (o1.equals(o2)
returns true
)
hash to the same Int
(o1.hashCode.equals(o2.hashCode)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Returns a hash code value for the object
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash
codes (o1.hashCode.equals(o2.hashCode)
) yet not be
equal (o1.equals(o2)
returns false
). A
degenerate implementation could always return 0
.
However, it is required that if two objects are equal
(o1.equals(o2)
returns true
) that they
have identical hash codes
(o1.hashCode.equals(o2.hashCode)
). Therefore, when
overriding this method, be sure to verify that the behavior is
consistent with the equals
method.
Returns a string representation of the object
Returns a string representation of the object.
The default representation is platform dependent.
Trait that facilitates the testing of private methods.
To test a private method, mix in trait
PrivateMethodTester
and create aPrivateMethod
object, like this:The type parameter on
PrivateMethod
, in this caseString
, is the result type of the private method you wish to invoke. The symbol passed to thePrivateMethod.apply
factory method, in this case'decorateToStringValue
, is the name of the private method to invoke. To test the private method, use theinvokePrivate
operator, like this:Here,
targetObject
is a variable or singleton object name referring to the object whose private method you want to test. You pass the arguments to the private method in the parentheses after thePrivateMethod
object. The result type of aninvokePrivate
operation will be the type parameter of thePrivateMethod
object, thus you need not cast the result to use it. In other words, after creating aPrivateMethod
object, the syntax to invoke the private method looks like a regular method invocation, but with the dot (.
) replaced byinvokePrivate
. The private method is invoked dynamically via reflection, so if you have a typo in the method name symbol, specify the wrong result type, or pass invalid parameters, theinvokePrivate
operation will compile, but throw an exception at runtime.One limitation to be aware of is that you can't use
PrivateMethodTester
to test a private method declared in a trait, because the class the trait gets mixed into will not declare that private method. Only the class generated to hold method implementations for the trait will have that private method. If you want to test a private method declared in a trait, and that method does not use any state of that trait, you can move the private method to a companion object for the trait and test it usingPrivateMethodTester
that way. If the private trait method you want to test uses the trait's state, your best options are to test it indirectly via a non-private trait method that calls the private method, or make the private method package access and test it directly via regular static method invocations.