1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 20 package org.apache.commons.pipeline; 21 22 /** 23 * <p>This interface represents a factory that is used by a {@link Pipeline} to create 24 * a driver for a {@link Stage} when that stage is added to the pipeline. The factory 25 * pattern is used here to ensure that each stage is run by a unique driver 26 * instance.</p> 27 * 28 * <p>In order to guarantee that StageDriverFactory instances can be used 29 * effectively in configuration frameworks, each StageDriverFactory implementation 30 * <em>must</em> provide a no-argument constructor.</p> 31 */ 32 public interface StageDriverFactory<T extends StageDriver> { 33 /** 34 * This method is used to create a driver that will run the specified stage 35 * in the specified context. 36 * @param stage The stage to be run by the newly created driver. 37 * @param context The context in which the stage will be run 38 * @return The newly created driver 39 */ 40 public T createStageDriver(Stage stage, StageContext context); 41 }