org.jboss.arquillian.spring.integration.context.TestScopeApplicationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arquillian-service-integration-spring Show documentation
Spring Framework service integration for Arquillian
The newest version!
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, 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.spring.integration.context;

import org.jboss.arquillian.core.spi.Validate;
import org.jboss.arquillian.test.spi.TestClass;
import org.springframework.context.ApplicationContext;

/**
 * A test scope application context.
 *
 * @author Jakub Narloch
 * @version $Revision: $
 */
public class TestScopeApplicationContext {

    /**
     * Represents instance of {@link ApplicationContext}.
     */
    private final ApplicationContext applicationContext;

    /**
     * Represents the instance of the test class wrapper.
     */
    private final TestClass testClass;

    /**
     * Represents whether the application context should be closed after the tests.
     */
    private final boolean closable;

    /**
     * Creates new instance of {@link TestScopeApplicationContext} class with given application context.
     *
     * @param applicationContext the {@link ApplicationContext}
     * @param testClass          the test class wrapper
     * @param closable           whether the application context should be closed after the tests
     *
     * @throws IllegalArgumentException if {@code applicationContext} is null or {@code testClass} is null
     */
    public TestScopeApplicationContext(ApplicationContext applicationContext, TestClass testClass, boolean closable) {

        Validate.notNull(applicationContext, "The 'applicationContext' must be not null.");
        Validate.notNull(testClass, "The 'testClass' must be not null.");

        this.applicationContext = applicationContext;
        this.testClass = testClass;
        this.closable = closable;
    }

    /**
     * Retrieves {@link ApplicationContext} instance.
     *
     * @return the {@link ApplicationContext}
     */
    public ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * Retrieves the test class for which this application context has been created.
     *
     * @return the test class.
     */
    public TestClass getTestClass() {
        return testClass;
    }

    /**
     * Retrieves whether the application context should be closed after the tests.
     *
     * @return whether the application context should be closed after the tests
     */
    public boolean isClosable() {
        return closable;
    }
}