View Javadoc

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  package org.apache.onami.factoryannotation;
20  
21  import java.lang.annotation.Annotation;
22  
23  import com.google.inject.TypeLiteral;
24  import com.google.inject.spi.HasDependencies;
25  
26  /**
27   * A binding interface representing the actual annotation factory based binding
28   * 
29   * @param <T> The type to be injected
30   * @param <A> Annotation type where injection happens
31   */
32  public interface FactoryAnnotationBinding<T, A extends Annotation>
33      extends HasDependencies
34  {
35  
36      /**
37       * Returns the {@link TypeLiteral} of the element to be injected.
38       */
39      TypeLiteral<T> getElementTypeLiteral();
40  
41      /**
42       * Returns the bound annotation type this binding reacts on.
43       */
44      Class<A> getAnnotationType();
45  
46      /**
47       * Tests the annotation for be handled by the underlying {@link FactoryAnnotationProvider}.
48       * 
49       * @param annotation An actual annotation to be tested for being accepted by the underlying
50       *            {@link FactoryAnnotationProvider} .
51       */
52      boolean acceptAnnotation( A annotation );
53  
54  }