org.apache.juneau.html.annotation.Html 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.html.annotation;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import java.lang.annotation.*;

import org.apache.juneau.annotation.*;
import org.apache.juneau.html.*;

/**
 * Annotation that can be applied to classes, fields, and methods to tweak how they are handled by {@link HtmlSerializer}.
 *
 * 
 * Can be used in the following locations:
 * 

 * 	Marshalled classes/methods/fields.
 * 	
@Rest-annotated classes and @RestOp-annotated methods when an {@link #on()} value is specified.
 * 
 *
 * See Also:

 * 	@Html Annotation
 * 	
HTML Details
 * 
 */
@Documented
@Target({TYPE,FIELD,METHOD})
@Retention(RUNTIME)
@Inherited
@Repeatable(HtmlAnnotation.Array.class)
@ContextApply(HtmlAnnotation.Apply.class)
public @interface Html {

	/**
	 * Use the specified anchor text when serializing a URI.
	 *
	 * 
	 * The text can contain any bean property values resolved through variables of the form "{property-name}".
	 *
	 * 
Example:
	 * 
	 * 	// Produces <a href='...'>drive</a> when serialized to HTML.
	 * 	@Html(anchorText="drive")
	 * 	@URI // Treat property as a URL
	 * 	public String getDrive() {...}
	 * 
	 *
	 * 
	 * This overrides the behavior specified by {@link org.apache.juneau.html.HtmlSerializer.Builder#uriAnchorText(AnchorText)}.
	 *
	 * @return The annotation value.
	 */
	String anchorText() default "";

	/**
	 * Specifies what format to use for the HTML element.
	 *
	 * @return The annotation value.
	 */
	HtmlFormat format() default HtmlFormat.HTML;

	/**
	 * Adds a hyperlink to a bean property when rendered as HTML.
	 *
	 * 

	 * The text can contain any bean property values resolved through variables of the form "{property-name}".
	 *
	 * 

	 * The URLs can be any of the following forms:
	 * 

	 * 	Absolute - e.g. "http://host:123/myContext/myServlet/myPath"
	 * 	
Context-root-relative - e.g. "/myContext/myServlet/myPath"
	 * 	
Context-relative - e.g. "context:/myServlet/myPath"
	 * 	
Servlet-relative - e.g. "servlet:/myPath"
	 * 	
Path-info-relative - e.g. "myPath"
	 * 
	 *
	 * Example:
	 * 
	 * 	public class FileSpace {
	 *
	 * 		@Html(link="servlet:/drive/{drive}")
	 * 		public String getDrive() {
	 * 			...;
	 * 		}
	 * 	}
	 * 
	 *
	 * @return The annotation value.
	 */
	String link() default "";

	/**
	 * When true, don't add headers to tables.
	 *
	 * See Also:

	 * 	{@link org.apache.juneau.html.HtmlSerializer.Builder#addKeyValueTableHeaders()}
	 * 
	 *
	 * @return The annotation value.
	 */
	boolean noTableHeaders() default false;

	/**
	 * When true, collections of beans should be rendered as trees instead of tables.
	 *
	 * 
	 * Default is false.
	 *
	 * @return The annotation value.
	 */
	boolean noTables() default false;

	/**
	 * 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 {};

	/**
	 * Associates an {@link HtmlRender} with a bean property for custom HTML rendering of the property.
	 *
	 * 
	 * This annotation applies to bean properties and classes.
	 *
	 * @return The annotation value.
	 */
	@SuppressWarnings("rawtypes")
	Class render() default HtmlRender.class;
}