org.jmock.internal
Class InvocationExpectation

java.lang.Object
  org.jmock.internal.InvocationExpectation

All Implemented Interfaces:

org.hamcrest.SelfDescribing, Expectation

public class InvocationExpectation
extends Object
implements Expectation

An expectation of zero or more matching invocations.

Author:

npryce, smgf

Constructor Summary

InvocationExpectation()

Method Summary

void	addOrderingConstraint(OrderingConstraint orderingConstraint)
void	addSideEffect(SideEffect sideEffect)
boolean	allowsMoreInvocations() Can more Invocations expected by this Expectation still occur?
void	describeMismatch(Invocation invocation, org.hamcrest.Description description)
void	describeTo(org.hamcrest.Description description)
Object	invoke(Invocation invocation) Invokes the expectation: records that the invocation has occurred and fakes some behaviour in response.
boolean	isSatisfied() Have enough Invocations expected by this Expectation occurred?
boolean	matches(Invocation invocation) Can the Expectation be invoked with invocation?
void	setAction(Action action)
void	setCardinality(Cardinality cardinality)
void	setDefaultAction(Action action)
void	setMethod(Method method)
void	setMethodMatcher(org.hamcrest.Matcher<? super Method> matcher)
void	setObjectMatcher(org.hamcrest.Matcher<?> objectMatcher)
void	setParametersMatcher(ParametersMatcher parametersMatcher)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvocationExpectation

public InvocationExpectation()

Method Detail

setCardinality

public void setCardinality(Cardinality cardinality)

setObjectMatcher

public void setObjectMatcher(org.hamcrest.Matcher<?> objectMatcher)

setMethod

public void setMethod(Method method)

setMethodMatcher

public void setMethodMatcher(org.hamcrest.Matcher<? super Method> matcher)

setParametersMatcher

public void setParametersMatcher(ParametersMatcher parametersMatcher)

addOrderingConstraint

public void addOrderingConstraint(OrderingConstraint orderingConstraint)

addSideEffect

public void addSideEffect(SideEffect sideEffect)

setAction

public void setAction(Action action)

setDefaultAction

public void setDefaultAction(Action action)

describeTo

public void describeTo(org.hamcrest.Description description)

Specified by:

describeTo in interface org.hamcrest.SelfDescribing

describeMismatch

public void describeMismatch(Invocation invocation,
                             org.hamcrest.Description description)

Specified by:

describeMismatch in interface Expectation

isSatisfied

public boolean isSatisfied()

Description copied from interface: Expectation

Have enough Invocations expected by this Expectation occurred?

Specified by:

isSatisfied in interface Expectation

Returns:

true if the expectation has received enough of its expected invocations, false otherwise.

allowsMoreInvocations

public boolean allowsMoreInvocations()

Description copied from interface: Expectation

Can more Invocations expected by this Expectation still occur?

Specified by:

allowsMoreInvocations in interface Expectation

Returns:

true if invocations expected by this expectation can still occur, false otherwise.

matches

public boolean matches(Invocation invocation)

Description copied from interface: Expectation

Can the Expectation be invoked with invocation?

Specified by:

matches in interface Expectation

Returns:

true if the expectation can be invoked with invocation, false otherwise.

invoke

public Object invoke(Invocation invocation)
              throws Throwable

Description copied from interface: Expectation

Invokes the expectation: records that the invocation has occurred and fakes some behaviour in response.

Specified by:

invoke in interface Expectation

Parameters:

invocation - The invocation to record and fake.

Returns:

A result that is eventually returned from the method call that caused the invocation.

Throws:

Throwable - An exception that is eventually thrown from the method call that caused the invocation.

IllegalStateException - The expectation has been invoked with a method that it doesn't match or the faked behaviour has been set up incorrectly. For example, IllegalStateException is thrown when trying to return a value or throw a checked exception that is incompatible with the return type of the method being mocked