EasyMockProvider.java

package org.needle4j.mock;

import java.lang.reflect.Modifier;

import org.easymock.EasyMock;
import org.easymock.EasyMockSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * An EasyMock specific {@link MockProvider} implementation. For details, see
 * the EasyMock documentation.
 * 
 * <pre>
 * Example:
 * 
 * public class Test {
 * 
 * 	private EasyMockProvider mockProvider = new EasyMockProvider();
 * 
 * 	@Test
 * 	public void test() {
 * 
 * 	 UserDao userDao = mockProvider.createMock(UserDao.class);
 * 
 * 	 mockProvider.replayAll();
 * 
 * 	 // ... use mocks
 * 
 * 	 mockProvider.verifyAll();
 * 	}
 * }
 * </pre>
 */
public class EasyMockProvider extends EasyMockSupport implements MockProvider {

    private static final Logger LOG = LoggerFactory.getLogger(EasyMockProvider.class);

    /**
     * {@inheritDoc} By default a mock with nice behavior. Skipping creation, if
     * the type is final or primitive. For details, see the EasyMock
     * documentation.
     * 
     * @return the mock object or null, if the type is final or primitive.
     */
    @Override
    public <T> T createMockComponent(final Class<T> type) {

        if (Modifier.isFinal(type.getModifiers()) || type.isPrimitive()) {
            LOG.warn("Skipping creation of a mock : {} as it is final or primitive type.", type.getSimpleName());
            return null;
        }
        T mock = createNiceMock(type);

        return mock;

    }

    /**
     * Resets the given mock objects and turns them to a mock with nice
     * behavior. For details, see the EasyMock documentation.
     * 
     * @param mocks
     *            the mock objects
     */
    public void resetToNice(final Object... mocks) {
        EasyMock.resetToNice(mocks);
    }

    /**
     * Resets the given mock object and turns them to a mock with nice behavior.
     * For details, see the EasyMock documentation.
     * 
     * @param mock
     *            the mock object
     * 
     * @return the mock object
     */
    @SuppressWarnings("unchecked")
    public <X> X resetToNice(final Object mock) {
        EasyMock.resetToNice(mock);
        return (X) mock;
    }

    /**
     * Resets the given mock objects and turns them to a mock with strict
     * behavior. For details, see the EasyMock documentation.
     * 
     * @param mocks
     *            the mock objects
     */
    public void resetToStrict(final Object... mocks) {
        EasyMock.resetToStrict(mocks);
    }

    /**
     * Resets the given mock object and turns them to a mock with strict
     * behavior. For details, see the EasyMock documentation.
     * 
     * @param mock
     *            the mock objects
     * 
     * @return the mock object
     */
    @SuppressWarnings("unchecked")
    public <X> X resetToStrict(final Object mock) {
        EasyMock.resetToStrict(mock);
        return (X) mock;
    }

    /**
     * Resets the given mock objects and turns them to a mock with default
     * behavior. For details, see the EasyMock documentation.
     * 
     * @param mocks
     *            the mock objects
     */
    public void resetToDefault(final Object... mocks) {
        EasyMock.resetToDefault(mocks);
    }

    /**
     * Resets the given mock object and turns them to a mock with default
     * behavior. For details, see the EasyMock documentation.
     * 
     * @param mock
     *            the mock object
     * 
     * @return the mock object
     */
    @SuppressWarnings("unchecked")
    public <X> X resetToDefault(final Object mock) {
        EasyMock.resetToDefault(mock);
        return (X) mock;
    }

}