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.validation;
19  
20  import java.lang.annotation.ElementType;
21  import java.lang.annotation.Retention;
22  import java.lang.annotation.RetentionPolicy;
23  import java.lang.annotation.Target;
24  
25  /**
26   * This annotation is used to aggregate information about the branches
27   * served by a give Stage.
28   *
29   *
30   */
31  @Target(ElementType.TYPE)
32  @Retention(RetentionPolicy.RUNTIME)
33  public @interface Branches {
34      /**
35       * Returns the array of branch key/production pairs that describe the
36       * data being produced by the annotated stage on various branches.
37       */
38      public ProductionOnBranch[] productionOnBranches() default { };
39      
40      /**
41       * Returns the array of branch keys for which the stage produces the
42       * same type of object as it consumes.
43       */
44      public String[] producesConsumedOnBranches() default { };
45  }