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 static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020/**
021 * Ignore classes, fields, and methods from being interpreted as bean or bean components.
022 * 
023 * <p>
024 * Applied to classes that may look like beans, but you want to be treated as non-beans.
025 * For example, if you want to force a bean to be converted to a string using the <code>toString()</code> method, use
026 * this annotation on the class.
027 * 
028 * <p>
029 * Applies to fields that should not be interpreted as bean property fields.
030 * 
031 * <p>
032 * Applies to getters or setters that should not be interpreted as bean property getters or setters.
033 * 
034 * <h5 class='section'>See Also:</h5>
035 * <ul>
036 *    <li class='link'><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanIgnoreAnnotation">Overview &gt; juneau-marshall &gt; @BeanIgnore Annotation</a>
037 * </ul>
038 */
039@Documented
040@Target({FIELD,METHOD,TYPE})
041@Retention(RUNTIME)
042@Inherited
043public @interface BeanIgnore {}
044