001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.annotation;
014
015import java.lang.annotation.*;
016import java.lang.reflect.*;
017
018import org.apache.juneau.*;
019import org.apache.juneau.reflect.*;
020
021/**
022 * A concrete implementation of the {@link BeanIgnore} annotation.
023 *
024 * <ul class='seealso'>
025 *    <li class='jm'>{@link BeanContextBuilder#annotations(Annotation...)}
026 * </ul>
027 */
028public class BeanIgnoreAnnotation implements BeanIgnore {
029
030   private String on = "";
031
032   /**
033    * Constructor.
034    *
035    * @param on The initial value for the <c>on</c> property.
036    *    <br>See {@link BeanIgnore#on()}
037    */
038   public BeanIgnoreAnnotation(String on) {
039      on(on);
040   }
041
042   /**
043    * Constructor.
044    *
045    * @param on The initial value for the <c>on</c> property.
046    *    <br>See {@link BeanIgnore#on()}
047    */
048   public BeanIgnoreAnnotation(Class<?> on) {
049      on(on);
050   }
051
052   /**
053    * Constructor.
054    *
055    * @param on The initial value for the <c>on</c> property.
056    *    <br>See {@link BeanIgnore#on()}
057    */
058   public BeanIgnoreAnnotation(Method on) {
059      on(on);
060   }
061
062   /**
063    * Constructor.
064    *
065    * @param on The initial value for the <c>on</c> property.
066    *    <br>See {@link BeanIgnore#on()}
067    */
068   public BeanIgnoreAnnotation(Field on) {
069      on(on);
070   }
071
072   /**
073    * Constructor.
074    *
075    * @param on The initial value for the <c>on</c> property.
076    *    <br>See {@link BeanIgnore#on()}
077    */
078   public BeanIgnoreAnnotation(Constructor<?> on) {
079      on(on);
080   }
081
082   @Override
083   public Class<? extends Annotation> annotationType() {
084      return BeanIgnore.class;
085   }
086
087   @Override
088   public String on() {
089      return on;
090   }
091
092   /**
093    * Sets the <c>on</c> property on this annotation.
094    *
095    * @param value The new value for this property.
096    * @return This object (for method chaining).
097    */
098   public BeanIgnoreAnnotation on(String value) {
099      this.on = value;
100      return this;
101   }
102
103   /**
104    * Sets the <c>on</c> property on this annotation.
105    *
106    * @param value The new value for this property.
107    * @return This object (for method chaining).
108    */
109   public BeanIgnoreAnnotation on(Class<?> value) {
110      this.on = value.getName();
111      return this;
112   }
113
114   /**
115    * Sets the <c>on</c> property on this annotation.
116    *
117    * @param value The new value for this property.
118    * @return This object (for method chaining).
119    */
120   public BeanIgnoreAnnotation on(Method value) {
121      this.on = MethodInfo.of(value).getFullName();
122      return this;
123   }
124
125   /**
126    * Sets the <c>on</c> property on this annotation.
127    *
128    * @param value The new value for this property.
129    * @return This object (for method chaining).
130    */
131   public BeanIgnoreAnnotation on(Field value) {
132      this.on = value.getName();
133      return this;
134   }
135
136   /**
137    * Sets the <c>on</c> property on this annotation.
138    *
139    * @param value The new value for this property.
140    * @return This object (for method chaining).
141    */
142   public BeanIgnoreAnnotation on(Constructor<?> value) {
143      this.on = ConstructorInfo.of(value).getFullName();
144      return this;
145   }
146}