org.scalatest.mock

# JMockExpectations

#### class JMockExpectations extends Expectations

Subclass of `org.jmock.Expectations` that provides `withArg`alternatives to the `with` methods defined in its superclass.

`JMockCycle`'s `expecting` method of passes an instance of this class to the function passed into `expectations`. Because `JMockExpectations`extends `org.jmock.Expectations`, all of the `Expectations` methods are available to be invoked on instances of this class, in addition to several overloaded `withArg` methods defined in this class. These `withArg` methods simply invoke corresponding `with` methods on `this`. Because `with` is a keyword in Scala, to invoke these directly you must surround them in back ticks, like this:

    oneOf (mockCollaborator).documentAdded(with("Document"))

By importing the members of the `JMockExpectations` object passed to a `JMockCycle`'s `executing` method, you can instead call `withArg` with no back ticks needed:

    oneOf (mockCollaborator).documentAdded(withArg("Document"))

attributes: final

authors:

1. Bill Venners

Inherited

1. Hide All
2. Show all

1. Expectations
2. ActionClause
3. ArgumentConstraintPhrases
4. CardinalityClause
5. ExpectationBuilder
6. AnyRef
7. Any

Visibility

1. Public
2. All

### Instance constructors

1. #### new JMockExpectations()

### Value Members

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

   attributes: final
   definition classes: AnyRef

2. #### def !=(arg0: Any): Boolean

   `o != arg0` is the same as `!(o == (arg0))`.

   `o != arg0` is the same as `!(o == (arg0))`.

   arg0

     the object to compare against this object for dis-equality.

   returns

     `false` if the receiver object is equivalent to the argument; `true` otherwise.

   attributes: final
   definition classes: Any

3. #### def ##(): Int

   attributes: final
   definition classes: AnyRef → Any

4. #### def $asInstanceOf[T0](): T0

   attributes: final
   definition classes: AnyRef

5. #### def $isInstanceOf[T0](): Boolean

   attributes: final
   definition classes: AnyRef

6. #### def ==(arg0: AnyRef): Boolean

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   `o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: AnyRef

7. #### def ==(arg0: Any): Boolean

   `o == arg0` is the same as `o.equals(arg0)`.

   `o == arg0` is the same as `o.equals(arg0)`.

   arg0

     the object to compare against this object for equality.

   returns

     `true` if the receiver object is equivalent to the argument; `false` otherwise.

   attributes: final
   definition classes: Any

8. #### def allowing[T](arg0: T): T

   definition classes: Expectations → CardinalityClause

9. #### def allowing(arg0: org.hamcrest.Matcher[_]): MethodClause

   definition classes: Expectations → CardinalityClause

10. #### def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type `T0`.

    This method is used to cast the receiver object to be of type `T0`.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      the receiver object.

    attributes: final
    definition classes: Any

11. #### def atLeast(arg0: Int): ReceiverClause

    definition classes: Expectations → CardinalityClause

12. #### def atMost(arg0: Int): ReceiverClause

    definition classes: Expectations → CardinalityClause

13. #### def between(arg0: Int, arg1: Int): ReceiverClause

    definition classes: Expectations → CardinalityClause

14. #### def buildExpectations(arg0: Action, arg1: ExpectationCollector): Unit

    definition classes: Expectations → ExpectationBuilder

15. #### def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the `clone` method is platform dependent.

    returns

      a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef

16. #### def currentBuilder(): InvocationExpectationBuilder

    attributes: protected
    definition classes: Expectations

17. #### def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

    The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

    Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    arg0

      the object to compare against this object for reference equality.

    returns

      `true` if the argument is a reference to the receiver object; `false` otherwise.

    attributes: final
    definition classes: AnyRef

18. #### def equals(arg0: Any): Boolean

    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 [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`. * It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. * It is transitive: for any instances `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 scala.Int (`o1.hashCode.equals(o2.hashCode)`).

    arg0

      the object to compare against this object for equality.

    returns

      `true` if the receiver object is equivalent to the argument; `false` otherwise.

    definition classes: AnyRef → Any

19. #### def exactly(arg0: Int): ReceiverClause

    definition classes: Expectations → CardinalityClause

20. #### def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef

21. #### def getClass(): java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef

22. #### def hashCode(): Int

    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

      the hash code value for the object.

    definition classes: AnyRef → Any

23. #### def ignoring(arg0: org.hamcrest.Matcher[_]): MethodClause

    definition classes: Expectations → CardinalityClause

24. #### def ignoring[T](arg0: T): T

    definition classes: Expectations → CardinalityClause

25. #### def inSequence(arg0: Sequence): Unit

    definition classes: Expectations

26. #### def inSequences(arg0: <repeated...>[Sequence]): Unit

    definition classes: Expectations

27. #### def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    This method is used to test whether the dynamic type of the receiver object is `T0`.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

      `true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

    attributes: final
    definition classes: Any

28. #### def ne(arg0: AnyRef): Boolean

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    `o.ne(arg0)` is the same as `!(o.eq(arg0))`.

    arg0

      the object to compare against this object for reference dis-equality.

    returns

      `false` if the argument is not a reference to the receiver object; `true` otherwise.

    attributes: final
    definition classes: AnyRef

29. #### def never[T](arg0: T): T

    definition classes: Expectations → CardinalityClause

30. #### def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

31. #### def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef

32. #### def one[T](arg0: T): T

    definition classes: Expectations → CardinalityClause

33. #### def oneOf[T](arg0: T): T

    definition classes: Expectations

34. #### def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef

35. #### def then(arg0: State): Unit

    definition classes: Expectations

36. #### def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

      a string representation of the object.

    definition classes: AnyRef → Any

37. #### def wait(): Unit

    attributes: final
    definition classes: AnyRef

38. #### def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef

39. #### def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef

40. #### def when(arg0: StatePredicate): Unit

    definition classes: Expectations

41. #### def will(arg0: Action): Unit

    definition classes: Expectations → ActionClause

42. #### def with[T](arg0: T): T

    definition classes: Expectations

43. #### def with(arg0: Double): Double

    definition classes: Expectations

44. #### def with(arg0: Float): Float

    definition classes: Expectations

45. #### def with(arg0: Long): Long

    definition classes: Expectations

46. #### def with(arg0: Int): Int

    definition classes: Expectations

47. #### def with(arg0: Char): Char

    definition classes: Expectations

48. #### def with(arg0: Short): Short

    definition classes: Expectations

49. #### def with(arg0: Byte): Byte

    definition classes: Expectations

50. #### def with(arg0: Boolean): Boolean

    definition classes: Expectations

51. #### def with(arg0: Matcher[Double]): Double

    definition classes: Expectations → ArgumentConstraintPhrases

52. #### def with(arg0: Matcher[Float]): Float

    definition classes: Expectations → ArgumentConstraintPhrases

53. #### def with(arg0: Matcher[Long]): Long

    definition classes: Expectations → ArgumentConstraintPhrases

54. #### def with(arg0: Matcher[Integer]): Int

    definition classes: Expectations → ArgumentConstraintPhrases

55. #### def with(arg0: Matcher[Character]): Char

    definition classes: Expectations

56. #### def with(arg0: Matcher[Short]): Short

    definition classes: Expectations → ArgumentConstraintPhrases

57. #### def with(arg0: Matcher[Byte]): Byte

    definition classes: Expectations → ArgumentConstraintPhrases

58. #### def with(arg0: Matcher[Boolean]): Boolean

    definition classes: Expectations → ArgumentConstraintPhrases

59. #### def with[T](arg0: Matcher[T]): T

    definition classes: Expectations → ArgumentConstraintPhrases

60. #### def withArg(matcher: Matcher[Char]): Char

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

61. #### def withArg(matcher: Matcher[Double]): Double

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

62. #### def withArg(matcher: Matcher[Float]): Float

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

63. #### def withArg(matcher: Matcher[Boolean]): Boolean

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

64. #### def withArg(matcher: Matcher[Long]): Long

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

65. #### def withArg(matcher: Matcher[Byte]): Byte

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

66. #### def withArg(matcher: Matcher[Short]): Short

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

67. #### def withArg(matcher: Matcher[Int]): Int

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

68. #### def withArg[T](matcher: Matcher[T]): T

    Invokes `with` on this instance, passing in the passed matcher.

    Invokes `with` on this instance, passing in the passed matcher.

69. #### def withArg(value: Char): Char

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

70. #### def withArg(value: Double): Double

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

71. #### def withArg(value: Float): Float

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

72. #### def withArg(value: Boolean): Boolean

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

73. #### def withArg(value: Long): Long

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

74. #### def withArg(value: Byte): Byte

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

75. #### def withArg(value: Short): Short

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

76. #### def withArg(value: Int): Int

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.

77. #### def withArg[T](value: T): T

    Invokes `with` on this instance, passing in the passed value.

    Invokes `with` on this instance, passing in the passed value.