ReturnIteratorAction (jMock 2 Parent 2.8.4 API)

java.lang.Object
- org.jmock.lib.action.ReturnIteratorAction

All Implemented Interfaces:

org.hamcrest.SelfDescribing, Action, Invokable
```
public class ReturnIteratorAction
extends Object
implements Action
```
Returns an Iterator over a collection.

Author:

nat

Constructor Summary

Constructors
Constructor Description

ReturnIteratorAction(Object... array)

ReturnIteratorAction(Collection<?> collection)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`describeTo(org.hamcrest.Description description)`
`Iterator<?>`	`invoke(Invocation invocation)`	Performs an action in response to an invocation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReturnIteratorAction
```
public ReturnIteratorAction(Collection<?> collection)
```
  - ReturnIteratorAction
```
public ReturnIteratorAction(Object... array)
```
- Method Detail
  - invoke
```
public Iterator<?> invoke(Invocation invocation)
                   throws Throwable
```
    Description copied from interface: Invokable
    
    Performs an action in response to an invocation.
    
    Specified by:
    
    invoke in interface Invokable
    
    Parameters:
    
    invocation - The invocation to perform.
    
    Returns:
    
    The result of the invocation, if not throwing an exception. Must return null if the invoked method has a void return type.
    
    Throws:
    
    Throwable - An exception to be thrown to the caller, if not returning a value. Any checked exception thrown must be in the throws list of the invoked method.
  - describeTo
```
public void describeTo(org.hamcrest.Description description)
```
    Specified by:
    
    describeTo in interface org.hamcrest.SelfDescribing