org.apache.juneau.annotation.Example Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * 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.
 * 	
@Rest-annotated classes and @RestOp-annotated methods when an {@link #on()} value is specified.
 * 
 *
 * 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 {...}
 * 
 *
 * See Also:


 * 
 */
@Documented
@Target({FIELD,METHOD,TYPE})
@Retention(RUNTIME)
@Inherited
@Repeatable(ExampleAnnotation.Array.class)
@ContextApply(ExampleAnnotation.Applier.class)
public @interface Example {

	/**
	 * Dynamically apply this annotation to the specified classes/methods/fields.
	 *
	 * 
	 * Used in conjunction with {@link org.apache.juneau.BeanContext.Builder#applyAnnotations(Class...)} to dynamically apply an annotation to an existing class/method/field.
	 * It is ignored when the annotation is applied directly to classes/methods/fields.
	 *
	 * 
Valid patterns:
	 * 
	 *  Classes:
	 * 		
	 * 			Fully qualified:
	 * 				
	 * 					"com.foo.MyClass"
	 * 				
	 * 			
Fully qualified inner class:
	 * 				
	 * 					"com.foo.MyClass$Inner1$Inner2"
	 * 				
	 * 			
Simple:
	 * 				
	 * 					"MyClass"
	 * 				
	 * 			
Simple inner:
	 * 				
	 * 					"MyClass$Inner1$Inner2"
	 * 					
"Inner1$Inner2"
	 * 					
"Inner2"
	 * 				
	 * 		
	 * 	
Methods:
	 * 		
	 * 			Fully qualified with args:
	 * 				
	 * 					"com.foo.MyClass.myMethod(String,int)"
	 * 					
"com.foo.MyClass.myMethod(java.lang.String,int)"
	 * 					
"com.foo.MyClass.myMethod()"
	 * 				
	 * 			
Fully qualified:
	 * 				
	 * 					"com.foo.MyClass.myMethod"
	 * 				
	 * 			
Simple with args:
	 * 				
	 * 					"MyClass.myMethod(String,int)"
	 * 					
"MyClass.myMethod(java.lang.String,int)"
	 * 					
"MyClass.myMethod()"
	 * 				
	 * 			
Simple:
	 * 				
	 * 					"MyClass.myMethod"
	 * 				
	 * 			
Simple inner class:
	 * 				
	 * 					"MyClass$Inner1$Inner2.myMethod"
	 * 					
"Inner1$Inner2.myMethod"
	 * 					
"Inner2.myMethod"
	 * 				
	 * 		
	 * 	
Fields:
	 * 		
	 * 			Fully qualified:
	 * 				
	 * 					"com.foo.MyClass.myField"
	 * 				
	 * 			
Simple:
	 * 				
	 * 					"MyClass.myField"
	 * 				
	 * 			
Simple inner class:
	 * 				
	 * 					"MyClass$Inner1$Inner2.myField"
	 * 					
"Inner1$Inner2.myField"
	 * 					
"Inner2.myField"
	 * 				
	 * 		
	 * 	
A comma-delimited list of anything on this list.
	 * 
	 *
	 * See Also:

	 * 	Dynamically Applied Annotations
	 * 
	 *
	 * @return The annotation value.
	 */
	String[] on() default {};

	/**
	 * Dynamically apply this annotation to the specified classes.
	 *
	 * 
	 * Identical to {@link #on()} except allows you to specify class objects instead of a strings.
	 *
	 * 
See Also:

	 * 	Dynamically Applied Annotations
	 * 
	 *
	 * @return The annotation value.
	 */
	Class[] onClass() default {};

	/**
	 * An example of a POJO class.
	 *
	 * 
	 * Format is Lax-JSON.
	 *
	 * 
	 * This value is only used when the annotation is used on a type.
	 *
	 * @return The annotation value.
	 */
	String value() default "";
}