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 * Identifies examples for POJOs.
022 *
023 * <p>
024 * Can be used in the following locations:
025 * <ul>
026 *    <li>Static method that returns an example of the POJO.
027 *    <li>Static field that contains an example of the POJO.
028 *    <li>On a class.
029 * </ul>
030 *
031 * <h5 class='figure'>Examples:</h5>
032 * <p class='bcode w800'>
033 *    <jc>// On a static method.</jc>
034 *    <jk>public class</jk> A {
035 *
036 *       <ja>@Example</ja>
037 *       <jk>public static</jk> A example() {
038 *          <jk>return new</jk> A().foo(<js>"bar"</js>).baz(123);
039 *       }
040 *
041 *       ...
042 *    }
043 *
044 *    <jc>// On a static field.</jc>
045 *    <jk>public class</jk> B {
046 *
047 *       <ja>@Example</ja>
048 *       <jk>public static</jk> B EXAMPLE = <jk>new</jk> B().foo(<js>"bar"</js>).baz(123);
049 *
050 *       ...
051 *    }
052 *
053 *    <jc>// On a class.</jc>
054 *    <ja>@Example</js>(<js>"{foo:'bar',baz:123}"</js>)
055 *    <jk>public class</jk> C {...}
056 * </p>
057 */
058@Documented
059@Target({FIELD,METHOD,TYPE})
060@Retention(RUNTIME)
061@Inherited
062public @interface Example {
063
064   /**
065    * An example of a POJO class.
066    *
067    * <p>
068    * Format is Lax-JSON.
069    *
070    * <p>
071    * This value is only used when the annotation is used on a type.
072    */
073   String value() default "";
074}