/*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *   http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 package org.apache.onami.factoryannotation;

 import java.lang.annotation.Annotation;

 import java.lang.reflect.Constructor;

 import java.lang.reflect.Field;

 import java.lang.reflect.Member;

 import java.lang.reflect.Method;

 import com.google.inject.TypeLiteral;

 /**

  * This interface represents the injection point of the actual provision. In addiction to the

  * {@link FactoryAnnotationProvisionType} returned by {@link #getProvisionType()} the methods {@link #getConstructor()},

  * {@link #getMethod()} or {@link #getField()} methods return null or the actual {@link Member} that corresponds to the

  * injection point.

  * 

  * @param <T> The type to be injected

  * @param <A> Annotation type where injection happens

  */

 public interface FactoryAnnotationProvision<T, A extends Annotation>

 {

     /**

      * The type of provision to be executed

      */

     public static enum FactoryAnnotationProvisionType

     {

         /**

          * A method parameter provision

          */

         METHOD,

         /**

          * A constructor parameter provision

          */

         CONSTRUCTOR,

         /**

          * A field (instance member) provision

          */

         FIELD,

         /**

          * A static field (class member) provision

          */

         STATIC

     }

     /**

      * Returns the type of provision that happens at this injection point

      */

     FactoryAnnotationProvisionType getProvisionType();

     /**

      * If the provision type is {@link FactoryAnnotationProvisionType#CONSTRUCTOR} this returns the constructor of the

      * injection point otherwise it returns null.

      */

     Constructor<T> getConstructor();

     /**

      * If the provision type is {@link FactoryAnnotationProvisionType#METHOD} this returns the method of the injection

      * point otherwise it returns null.

      */

     Method getMethod();

     /**

      * If the provision type is {@link FactoryAnnotationProvisionType#CONSTRUCTOR} or

      * {@link FactoryAnnotationProvisionType#METHOD} this returns the parameter position of the parameter to be

      * provisioned otherwise if the provision type is a field it returns -1.

      */

     int getParameterPosition();

     /**

      * If the provision type is {@link FactoryAnnotationProvisionType#FIELD} or

      * {@link FactoryAnnotationProvisionType#STATIC} this returns the field of the injection point otherwise it returns

      * null.

      */

     Field getField();

     /**

      * Returns the target object to be provisioned.

      */

     T getTarget();

     /**

      * Returns the actual annotation of the bound annotation type.

      */

     A getProvisionAnnotation();

     /**

      * Returns an array of all available annotations at the actual provision position (field, method- / constructor

      * parameter).

      */

     Annotation[] getAnnotations();

     /**

      * Returns the {@link TypeLiteral} of the provisioned type.

      */

     TypeLiteral<T> getElementTypeLiteral();

 }