View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.pipeline;
19  
20  
21  /**
22   * Simple factory interface for creating pipelines. This interface is commonly implemented
23   * in different ways to allow creation of a pipeline based upon some external
24   * configuration source instead of in code.
25   */
26  public interface PipelineFactory {
27      /**
28       * Returns a Pipeline created by the factory.
29       * @throws org.apache.commons.pipeline.PipelineCreationException if there is an error creating the pipeline
30       * @return the newly created pipeline
31       */
32      public Pipeline createPipeline() throws PipelineCreationException;
33  }