Package org.kohsuke.stapler

Annotation Type QueryParameter

@Retention(RUNTIME)
@Target(PARAMETER)
@Documented
@InjectedParameter(HandlerImpl.class)
public @interface QueryParameter

Indicates that this parameter is injected from HTTP query parameter.

Author:

Kohsuke Kawaguchi

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	fixEmpty	If true, and the actual value of this parameter is "", null is passed instead.
boolean	required	If true, request without this header will be rejected.
String	value	query parameter name.

Element Detail

value

String value

query parameter name. By default, name of the parameter.

Default:

""

required

boolean required

If true, request without this header will be rejected.

Default:

false

fixEmpty

boolean fixEmpty

If true, and the actual value of this parameter is "", null is passed instead. This is useful to unify the treatment of the absence of the value vs the empty value.

Default:

false