| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| PipelineValidator |
|
| 0.0;0 |
| 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.validation; | |
| 19 | ||
| 20 | import java.util.List; | |
| 21 | import org.apache.commons.pipeline.Pipeline; | |
| 22 | import org.apache.commons.pipeline.Stage; | |
| 23 | import org.apache.commons.pipeline.StageDriverFactory; | |
| 24 | ||
| 25 | /** | |
| 26 | * This interface is used as the basis for validation strategies that may be | |
| 27 | * used to check the validity of a pipeline under construction. | |
| 28 | * | |
| 29 | * | |
| 30 | */ | |
| 31 | public interface PipelineValidator { | |
| 32 | /** | |
| 33 | * Implementations of this method should validate the overall structure of | |
| 34 | * the pipeline. | |
| 35 | * @param pipeline The pipeline to be validated | |
| 36 | * @return The list of validation errors encountered. An empty list is returned if no | |
| 37 | * errors are found. | |
| 38 | */ | |
| 39 | public List<ValidationFailure> validate(Pipeline pipeline); | |
| 40 | ||
| 41 | /** | |
| 42 | * Implementations of this method should validate whether or not the specified | |
| 43 | * stage can be added to the pipeline in its current state. | |
| 44 | * @param pipeline The pipeline to which the stage is being added | |
| 45 | * @param stage The added stage | |
| 46 | * @param driverFactory The StageDriverFactory used to create a StageDriver for the stage | |
| 47 | * @return The list of validation errors encountered, or an empty list if none were | |
| 48 | * encountered | |
| 49 | */ | |
| 50 | public List<ValidationFailure> validateAddStage(Pipeline pipeline, Stage stage, StageDriverFactory driverFactory); | |
| 51 | ||
| 52 | /** | |
| 53 | * Implementations of this method should validate whether or not the specified | |
| 54 | * branch can be added to the specified pipeline with the given key. | |
| 55 | * @param pipeline The pipeline to which the branch is being added | |
| 56 | * @param branchKey The key used to identify the new branch | |
| 57 | * @param branch The new branch pipeline | |
| 58 | * @return The list of validation failures, or an empty list if validation passes. | |
| 59 | */ | |
| 60 | public List<ValidationFailure> validateAddBranch(Pipeline pipeline, String branchKey, Pipeline branch); | |
| 61 | } |