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

import static org.apache.juneau.commons.utils.CollectionUtils.*;

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

import org.apache.juneau.commons.*;
import org.apache.juneau.commons.reflect.*;
import org.apache.juneau.commons.svl.*;

/**
 * Utility classes and methods for the {@link NamePropertyApply @NamePropertyApply} annotation.
 *
 */
public class NamePropertyApplyAnnotation {

   /**
    * Prevents instantiation.
    */
   private NamePropertyApplyAnnotation() {}

   /**
    * Applies targeted {@link NamePropertyApply} annotations to a {@link Context.Builder}.
    *
    * <p>
    * Passes the {@link NamePropertyApply @NamePropertyApply} annotation through to the builder's annotation list.
    * The {@link org.apache.juneau.commons.reflect.AnnotationProvider.Builder#addRuntimeAnnotations(java.util.List) AnnotationProvider.Builder#addRuntimeAnnotations(java.util.List)}
    * method handles unwrapping the nested {@link NameProperty @NameProperty} from {@link NamePropertyApply#value()} and registering it
    * under the targets specified by {@link NamePropertyApply#on()}.
    */
   @SuppressWarnings({
      "rawtypes" // Raw types required for reflective annotation application.
   })
   public static class Applier extends AnnotationApplier<NamePropertyApply,Context.Builder> {

      /**
       * Constructor.
       *
       * @param vr The resolver for resolving values in annotations. Must not be <jk>null</jk>.
       */
      public Applier(VarResolverSession vr) {
         super(NamePropertyApply.class, Context.Builder.class, vr);
      }

      @Override
      public void apply(AnnotationInfo<NamePropertyApply> ai, Context.Builder b) {
         NamePropertyApply a = ai.inner();
         if (isEmptyArray(a.on()))
            return;
         b.annotations(a);
      }
   }

   /**
    * Builder class.
    *
    * <h5 class='section'>See Also:</h5><ul>
    *    <li class='jm'>{@link MarshallingContext.Builder#annotations(Annotation...)}
    * </ul>
    */
   public static class Builder extends AppliedAnnotationObject.BuilderMF {

      NameProperty value = NamePropertyAnnotation.DEFAULT;

      /**
       * Constructor.
       */
      protected Builder() {
         super(NamePropertyApply.class);
      }

      /**
       * Sets the {@link NamePropertyApply#value()} property on this annotation.
       *
       * @param value The new value for this property.
       * @return This object.
       */
      public Builder value(NameProperty value) {
         this.value = value;
         return this;
      }

      @Override /* Overridden from AppliedAnnotationObject.Builder */
      public Builder on(String...value) {
         super.on(value);
         return this;
      }

      @Override /* Overridden from AppliedAnnotationObject.BuilderM */
      public Builder on(Method...value) {
         super.on(value);
         return this;
      }

      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
      public Builder on(Field...value) {
         super.on(value);
         return this;
      }

      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
      public Builder on(FieldInfo...value) {
         super.on(value);
         return this;
      }

      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
      public Builder on(MethodInfo...value) {
         super.on(value);
         return this;
      }

      /**
       * Instantiates a new {@link NamePropertyApply @NamePropertyApply} object initialized with this builder.
       *
       * @return A new {@link NamePropertyApply} object.
       */
      public NamePropertyApply build() {
         return new Object(this);
      }
   }

   @SuppressWarnings({
      "java:S2160" // equals() inherited from AnnotationObject compares all annotation interface methods; subclass fields are accessed via those methods
   })
   private static class Object extends AppliedAnnotationObject implements NamePropertyApply {

      private final NameProperty value;

      Object(NamePropertyApplyAnnotation.Builder b) {
         super(b);
         value = b.value;
      }

      @Override /* Overridden from NamePropertyApply */
      public NameProperty value() {
         return value;
      }
   }

   /** Default value */
   public static final NamePropertyApply DEFAULT = create().build();

   /**
    * Instantiates a new builder for this class.
    *
    * @return A new builder object.
    */
   public static Builder create() {
      return new Builder();
   }

   /**
    * Instantiates a new builder for this class.
    *
    * @param on The targets this annotation applies to.
    * @return A new builder object.
    */
   public static Builder create(String...on) {
      return create().on(on);
   }

   /**
    * Returns <jk>true</jk> if the specified annotation contains all default values.
    *
    * @param a The annotation to check. Can be <jk>null</jk> (returns <jk>true</jk>).
    * @return <jk>true</jk> if the specified annotation contains all default values.
    */
   public static boolean empty(NamePropertyApply a) {
      return a == null || DEFAULT.equals(a);
   }
}