001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.annotation;
018
019import static java.lang.annotation.ElementType.*;
020import static java.lang.annotation.RetentionPolicy.*;
021import static org.apache.juneau.commons.utils.CollectionUtils.*;
022
023import java.lang.annotation.*;
024import java.lang.reflect.*;
025
026import org.apache.juneau.*;
027import org.apache.juneau.commons.annotation.*;
028import org.apache.juneau.commons.reflect.*;
029import org.apache.juneau.svl.*;
030
031/**
032 * Utility classes and methods for the {@link NameProperty @NameProperty} annotation.
033 *
034 */
035public class NamePropertyAnnotation {
036   /**
037    * Applies targeted {@link NameProperty} annotations to a {@link org.apache.juneau.BeanContext.Builder}.
038    */
039   public static class Applier extends AnnotationApplier<NameProperty,BeanContext.Builder> {
040
041      /**
042       * Constructor.
043       *
044       * @param vr The resolver for resolving values in annotations.
045       */
046      public Applier(VarResolverSession vr) {
047         super(NameProperty.class, BeanContext.Builder.class, vr);
048      }
049
050      @Override
051      public void apply(AnnotationInfo<NameProperty> ai, BeanContext.Builder b) {
052         NameProperty a = ai.inner();
053         if (isEmptyArray(a.on()))
054            return;
055         b.annotations(copy(a, vr()));
056      }
057   }
058
059   /**
060    * A collection of {@link NameProperty @NameProperty annotations}.
061    */
062   @Documented
063   @Target({ METHOD, TYPE })
064   @Retention(RUNTIME)
065   @Inherited
066   public static @interface Array {
067
068      /**
069       * The child annotations.
070       *
071       * @return The annotation value.
072       */
073      NameProperty[] value();
074   }
075
076   /**
077    * Builder class.
078    *
079    * <h5 class='section'>See Also:</h5><ul>
080    *    <li class='jm'>{@link org.apache.juneau.BeanContext.Builder#annotations(Annotation...)}
081    * </ul>
082    */
083   public static class Builder extends AppliedAnnotationObject.BuilderMF {
084
085      private String[] description = {};
086
087      /**
088       * Constructor.
089       */
090      protected Builder() {
091         super(NameProperty.class);
092      }
093
094      /**
095       * Instantiates a new {@link NameProperty @NameProperty} object initialized with this builder.
096       *
097       * @return A new {@link NameProperty @NameProperty} object.
098       */
099      public NameProperty build() {
100         return new Object(this);
101      }
102
103      /**
104       * Sets the description property on this annotation.
105       *
106       * @param value The new value for this property.
107       * @return This object.
108       */
109      public Builder description(String...value) {
110         description = value;
111         return this;
112      }
113
114      @Override /* Overridden from AppliedAnnotationObject.Builder */
115      public Builder on(String...value) {
116         super.on(value);
117         return this;
118      }
119
120      @Override /* Overridden from AppliedAnnotationObject.BuilderM */
121      public Builder on(Method...value) {
122         super.on(value);
123         return this;
124      }
125
126      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
127      public Builder on(Field...value) {
128         super.on(value);
129         return this;
130      }
131
132      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
133      public Builder on(FieldInfo...value) {
134         super.on(value);
135         return this;
136      }
137
138      @Override /* Overridden from AppliedAnnotationObject.BuilderMF */
139      public Builder on(MethodInfo...value) {
140         super.on(value);
141         return this;
142      }
143
144   }
145
146   private static class Object extends AppliedAnnotationObject implements NameProperty {
147
148      private final String[] description;
149
150      Object(NamePropertyAnnotation.Builder b) {
151         super(b);
152         this.description = copyOf(b.description);
153      }
154
155      @Override /* Overridden from NameProperty */
156      public String[] description() {
157         return description;
158      }
159   }
160
161   /** Default value */
162   public static final NameProperty DEFAULT = create().build();
163
164   /**
165    * Creates a copy of the specified annotation.
166    *
167    * @param a The annotation to copy.s
168    * @param r The var resolver for resolving any variables.
169    * @return A copy of the specified annotation.
170    */
171   public static NameProperty copy(NameProperty a, VarResolverSession r) {
172      return create().on(r.resolve(a.on())).build();
173   }
174
175   /**
176    * Instantiates a new builder for this class.
177    *
178    * @return A new builder object.
179    */
180   public static Builder create() {
181      return new Builder();
182   }
183
184   /**
185    * Instantiates a new builder for this class.
186    *
187    * @param on The targets this annotation applies to.
188    * @return A new builder object.
189    */
190   public static Builder create(String...on) {
191      return create().on(on);
192   }
193}