Package org.kohsuke.stapler

Class AnnotationHandler<T extends Annotation>

java.lang.Object

org.kohsuke.stapler.AnnotationHandler<T>

Direct Known Subclasses:

AncestorInPath.HandlerImpl, Header.HandlerImpl, JsonBody.Handler, QueryParameter.HandlerImpl, SubmittedForm.Handler

public abstract class AnnotationHandler<T extends Annotation>
extends Object

Handles stapler parameter annotations by determining what values to inject for a method call.

Author:

Kohsuke Kawaguchi

See Also:

• InjectedParameter

Constructor Summary

Constructors

Constructor	Description
AnnotationHandler()

Method Summary

Modifier and Type	Method	Description
protected final Object	convert(Class targetType, String value)	Helper method for parse(StaplerRequest2, Annotation, Class, String) to convert to the right type from String.
Object	parse(StaplerRequest2 request, T a, Class type, String parameterName)
Object	parse(StaplerRequest request, T a, Class type, String parameterName)	Deprecated. use parse(StaplerRequest2, Annotation, Class, String)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnnotationHandler

public AnnotationHandler()

Method Details

parse

public Object parse(StaplerRequest2 request,
 T a,
 Class type,
 String parameterName)
             throws jakarta.servlet.ServletException

Parameters:

request - Current request being processed. Normally the parameter injection grabs some value from here and returns it. Never null.

a - The annotation object attached on the parameter for which this handler is configured. Never null

type - The type of the parameter. Any value returned from this method must be assignable to this type. Never null.

parameterName - Name of the parameter.

Throws:

jakarta.servlet.ServletException

parse

@Deprecated
public Object parse(StaplerRequest request,
 T a,
 Class type,
 String parameterName)
             throws javax.servlet.ServletException

Deprecated.

use parse(StaplerRequest2, Annotation, Class, String)

Throws:

javax.servlet.ServletException

convert

protected final Object convert(Class targetType,
 String value)

Helper method for parse(StaplerRequest2, Annotation, Class, String) to convert to the right type from String.