TestLifecycleEvent.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.arquillian.test.spi.event.suite;

import java.lang.reflect.Method;
import org.jboss.arquillian.test.spi.LifecycleMethodExecutor;

/**
 * A TestLifeCycleEvent is a type of TestEvent used for e.g. @Before/@After operations on the
 * Test instance.
 *
 * @author <a href="mailto:aslak@redhat.com">Aslak Knutsen</a>
 * @version $Revision: $
 */
public class TestLifecycleEvent extends TestEvent implements LifecycleEvent {
    private LifecycleMethodExecutor executor;

    /**
     * Create a new TestLifecycleEvent for a specific testInstance executing a specific testMethod. <br/>
     * <br/>
     * This will use a NO_OP LifecycleMethodExecutor.
     *
     * @param testInstance
     *     The Test instance
     * @param testMethod
     *     The Test Method being executed
     */
    public TestLifecycleEvent(Object testInstance, Method testMethod) {
        this(testInstance, testMethod, LifecycleMethodExecutor.NO_OP);
    }

    /**
     * Create a new TestLifecycleEvent for a specific testInstance executing a specific testMethod. <br/>
     *
     * @param testInstance
     *     The Test instance
     * @param testMethod
     *     The Test Method being executed
     * @param executor
     *     A call back when the LifecycleMethod represented by this event should be invoked
     */
    public TestLifecycleEvent(Object testInstance, Method testMethod, LifecycleMethodExecutor executor) {
        super(testInstance, testMethod);

        Validate.notNull(executor, "LifecycleMethodExecutor must be specified");
        this.executor = executor;
    }

    /* (non-Javadoc)
     * @see org.jboss.arquillian.spi.event.suite.LifecycleEvent#getExecutor()
     */
    public LifecycleMethodExecutor getExecutor() {
        return executor;
    }
}