Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
PipelineLifecycleJob |
|
| 1.0;1 |
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 | * This interface specifies a job or set of tasks that are to be run at a | |
22 | * well-specified points in the pipeline lifecycle. It is intended to be a | |
23 | * means by which third-party plugins can be added to the pipeline framework. | |
24 | */ | |
25 | public interface PipelineLifecycleJob { | |
26 | ||
27 | /** | |
28 | * This is called by the pipeline engine once the pipeline is fully configured, | |
29 | * just prior to stage driver start. | |
30 | */ | |
31 | public void onStart(Pipeline pipeline); | |
32 | ||
33 | /** | |
34 | * This is called by the pipeline engine after all data processing has completed. | |
35 | */ | |
36 | public void onFinish(Pipeline pipeline); | |
37 | ||
38 | } |