org.zkoss.bind.annotation.HeaderParam Maven / Gradle / Ivy
/* HeaderParam.java
Purpose:
Description:
History:
2011/12/16 Created by Dennis Chen
Copyright (C) 2011 Potix Corporation. All Rights Reserved.
*/
package org.zkoss.bind.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marker annotation to identify the name of a parameter of a method.
* The value of this parameter is getting from current http request header.
*
* @see Init
* @see Command
* @author dennis
* @since 6.0.0
*/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface HeaderParam {
/**
* name of the parameter.
* Since 9.5.0, it can be omitted if name is the same as the annotated parameter.
* @return name of the parameter
*/
String value() default "";
}