// ***************************************************************************************************************************
// * 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.juneau.reflect;

import java.lang.annotation.*;
import java.lang.reflect.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;

/**
 * Lightweight utility class for introspecting information about a constructor.
 */
@BeanIgnore
public final class ConstructorInfo extends ExecutableInfo implements Comparable<ConstructorInfo> {

   private final Constructor<?> c;

   //-----------------------------------------------------------------------------------------------------------------
   // Instantiation.
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Constructor.
    *
    * @param declaringClass The class that declares this method.
    * @param c The constructor being wrapped.
    * @param rc The "real" constructor if the constructor above is defined against a CGLIB proxy.
    */
   protected ConstructorInfo(ClassInfo declaringClass, Constructor<?> c, Constructor<?> rc) {
      super(declaringClass, c, rc);
      this.c = c;
   }

   /**
    * Convenience method for instantiating a {@link ConstructorInfo};
    *
    * @param declaringClass The class that declares this method.
    * @param c The constructor being wrapped.
    * @param rc The "real" constructor if the constructor above is defined against a CGLIB proxy.
    * @return A new {@link ConstructorInfo} object, or <jk>null</jk> if the method was null;
    */
   public static ConstructorInfo of(ClassInfo declaringClass, Constructor<?> c, Constructor<?> rc) {
      if (c == null)
         return null;
      return new ConstructorInfo(declaringClass, c, rc);
   }

   /**
    * Convenience method for instantiating a {@link ConstructorInfo};
    *
    * @param c The constructor being wrapped.
    * @return A new {@link ConstructorInfo} object, or <jk>null</jk> if the method was null;
    */
   public static ConstructorInfo of(Constructor<?> c) {
      if (c == null)
         return null;
      return new ConstructorInfo(ClassInfo.of(c.getDeclaringClass()), c, c);
   }

   /**
    * Returns the wrapped method.
    *
    * @return The wrapped method.
    */
   @SuppressWarnings("unchecked")
   public <T> Constructor<T> inner() {
      return (Constructor<T>)c;
   }


   //-----------------------------------------------------------------------------------------------------------------
   // Annotations
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Finds the annotation of the specified type defined on this constructor.
    *
    * @param a
    *    The annotation to search for.
    * @return
    *    The annotation if found, or <jk>null</jk> if not.
    */
   public final <T extends Annotation> T getAnnotation(Class<T> a) {
      return getAnnotation(a, MetaProvider.DEFAULT);
   }

   /**
    * Finds the annotation of the specified type defined on this constructor.
    *
    * @param a
    *    The annotation to search for.
    * @param mp
    *    The meta provider for looking up annotations on classes/methods/fields.
    * @return
    *    The first annotation found, or <jk>null</jk> if it doesn't exist.
    */
   public final <T extends Annotation> T getAnnotation(Class<T> a, MetaProvider mp) {
      return mp.getAnnotation(a, c);
   }

   /**
    * Returns <jk>true</jk> if the specified annotation is present on this constructor.
    *
    * @param a The annotation to check for.
    * @return <jk>true</jk> if the specified annotation is present on this constructor.
    */
   public final boolean hasAnnotation(Class<? extends Annotation> a) {
      return getAnnotation(a) != null;
   }


   //-----------------------------------------------------------------------------------------------------------------
   // Other methods
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Shortcut for calling the new-instance method on the underlying constructor.
    *
    * @param args the arguments used for the method call
    * @return The object returned from the constructor.
    * @throws ExecutableException Exception occurred on invoked constructor/method/field.
    */
   @SuppressWarnings("unchecked")
   public <T> T invoke(Object...args) throws ExecutableException {
      try {
         return (T)c.newInstance(args);
      } catch (InstantiationException | IllegalAccessException | InvocationTargetException e) {
         throw new ExecutableException(e);
      }
   }

   /**
    * Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't.
    *
    * <p>
    * Security exceptions thrown on the call to {@link Constructor#setAccessible(boolean)} are quietly ignored.
    *
    * @param v The minimum visibility.
    * @return
    *    The same constructor if visibility requirements met, or <jk>null</jk> if visibility requirement not
    *    met or call to {@link Constructor#setAccessible(boolean)} throws a security exception.
    */
   public ConstructorInfo makeAccessible(Visibility v) {
      if (v.transform(c) == null)
         return null;
      return this;
   }

   @Override
   public int compareTo(ConstructorInfo o) {
      int i = getSimpleName().compareTo(o.getSimpleName());
      if (i == 0) {
         i = getParamCount() - o.getParamCount();
         if (i == 0) {
            for (int j = 0; j < getParamCount() && i == 0; j++) {
               Class<?>[] tpt = rawParamTypes(), opt = o.rawParamTypes();
               i = tpt[j].getName().compareTo(opt[j].getName());
            }
         }
      }
      return i;
   }
}