ExamReactor.java

/*
 * Copyright 2011 Toni Menzel.
 *
 * 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.ops4j.pax.exam.spi;

import org.ops4j.pax.exam.Option;
import org.ops4j.pax.exam.TestProbeBuilder;

/**
 * Part of the Plumbing Level API. The container creation control process needs a higher level
 * control. Instead of directly creating containers out of
 * {@link org.ops4j.pax.exam.TestContainerFactory} it is recommended to use {@link ExamReactor}
 * instead.
 * <p>
 * You basically add some {@link Option}s and probes ({@link TestProbeBuilder} and get a retrieve a
 * {@link org.ops4j.pax.exam.spi.StagedExamReactor} that can be used to retrieve containers. Now its
 * up to the reactor and its configuration when to use and re-use the TestContainers.
 */
public interface ExamReactor {

    /**
     * Add the Configuration that contribute to desired container(s) you will get after calling
     * {@link #stage(StagedExamReactorFactory)}.
     * 
     * @param options
     *            a set of (user-end) options.
     */
    void addConfiguration(Option[] options);

    /**
     * Add the probe that contribute to desired container(s) you will get after calling
     * {@link #stage(StagedExamReactorFactory)}.
     * 
     * @param builder
     *            builder that will (in the end) create a probe to be installed in the target
     *            container.
     */
    void addProbe(TestProbeBuilder builder);

    /**
     * Last thing you parseForTests on the reactor usually. This gives you a unmodifiable Reactor
     * version.
     * 
     * @param factory
     *            to be used to stage. (usually a strategy)
     * 
     * @return new reactor that can be used to derive TestContainer instances.
     */
    StagedExamReactor stage(StagedExamReactorFactory factory);
}