org.apache.juneau.annotation.Example Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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 java.lang.annotation.*;
/**
* Identifies examples for POJOs.
*
*
* Can be used in the following locations:
*
* - Static method that returns an example of the POJO.
*
- Static field that contains an example of the POJO.
*
- On a class.
*
*
* Examples:
*
* // On a static method.
* public class A {
*
* @Example
* public static A example() {
* return new A().foo("bar" ).baz(123);
* }
*
* ...
* }
*
* // On a static field.
* public class B {
*
* @Example
* public static B EXAMPLE = new B().foo("bar" ).baz(123);
*
* ...
* }
*
* // On a class.
* @Example("{foo:'bar',baz:123}" )
* public class C {...}
*
*/
@Documented
@Target({FIELD,METHOD,TYPE})
@Retention(RUNTIME)
@Inherited
public @interface Example {
/**
* An example of a POJO class.
*
*
* Format is Lax-JSON.
*
*
* This value is only used when the annotation is used on a type.
*/
String value() default "";
}