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

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import static org.apache.juneau.commons.utils.CollectionUtils.*;

import java.lang.annotation.*;

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

/**
 * Utility classes and methods for the {@link Marshalled @Marshalled} annotation.
 *
 */
public class MarshalledAnnotation {
   /**
    * Applies targeted {@link Marshalled} annotations to a {@link org.apache.juneau.BeanContext.Builder}.
    */
   public static class Applier extends AnnotationApplier<Marshalled,BeanContext.Builder> {

      /**
       * Constructor.
       *
       * @param vr The resolver for resolving values in annotations.
       */
      public Applier(VarResolverSession vr) {
         super(Marshalled.class, BeanContext.Builder.class, vr);
      }

      @Override
      public void apply(AnnotationInfo<Marshalled> ai, BeanContext.Builder b) {
         Marshalled a = ai.inner();
         if (isEmptyArray(a.on()) && isEmptyArray(a.onClass()))
            return;
         b.annotations(copy(a, vr()));
      }
   }

   /**
    * A collection of {@link Marshalled @Marshalled annotations}.
    */
   @Documented
   @Target({ METHOD, TYPE })
   @Retention(RUNTIME)
   @Inherited
   public static @interface Array {

      /**
       * The child annotations.
       *
       * @return The annotation value.
       */
      Marshalled[] value();
   }

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

      private String[] description = {};
      private Class<?> implClass = void.class;
      private String example = "";

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

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

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

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

      /**
       * Sets the {@link Marshalled#implClass()} property on this annotation.
       *
       * @param value The new value for this property.
       * @return This object.
       */
      public Builder implClass(Class<?> value) {
         implClass = value;
         return this;
      }

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

      @Override /* Overridden from AppliedAnnotationObject.BuilderT */
      public Builder on(Class<?>...value) {
         super.on(value);
         return this;
      }

      @Override /* Overridden from AppliedOnClassAnnotationObject.Builder */
      public Builder onClass(Class<?>...value) {
         super.onClass(value);
         return this;
      }

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

      @Override /* Overridden from AppliedAnnotationObject.BuilderT */
      public Builder onClass(ClassInfo...value) {
         super.onClass(value);
         return this;
      }

   }

   private static class Object extends AppliedOnClassAnnotationObject implements Marshalled {

      private final String[] description;
      private final Class<?> implClass;
      private final String example;

      Object(MarshalledAnnotation.Builder b) {
         super(b);
         description = copyOf(b.description);
         example = b.example;
         implClass = b.implClass;
      }

      @Override /* Overridden from Marshalled */
      public String example() {
         return example;
      }

      @Override /* Overridden from Marshalled */
      public Class<?> implClass() {
         return implClass;
      }

      @Override /* Overridden from annotation */
      public String[] description() {
         return description;
      }
   }

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

   /**
    * Creates a copy of the specified annotation.
    *
    * @param a The annotation to copy.s
    * @param r The var resolver for resolving any variables.
    * @return A copy of the specified annotation.
    */
   public static Marshalled copy(Marshalled a, VarResolverSession r) {
      // @formatter:off
      return
         create()
         .example(r.resolve(a.example()))
         .implClass(a.implClass())
         .on(r.resolve(a.on()))
         .onClass(a.onClass())
         .build();
      // @formatter:on
   }

   /**
    * 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(Class<?>...on) {
      return create().on(on);
   }

   /**
    * 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);
   }
}