Package org.kohsuke.stapler

Class Function

java.lang.Object

org.kohsuke.stapler.Function

Direct Known Subclasses:

ForwardingFunction, Function.InstanceFunction

public abstract class Function
extends Object

Abstracts the difference between normal instance methods and static duck-typed methods.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Function.InstanceFunction	Normal instance methods.

Constructor Summary

Constructors

Constructor	Description
Function()

Method Summary

Modifier and Type	Method	Description
Function	contextualize(Object usage)	Caller uses this method to tell Function about how it is being used.
abstract <A extends Annotation> A	getAnnotation(Class<A> annotation)
abstract Annotation[]	getAnnotations()
abstract Class[]	getCheckedExceptionTypes()	Gets the type of checked exceptions.
abstract Class	getDeclaringClass()	Returns the Class object representing the class or interface that declares the executable represented by this object.
abstract String	getDisplayName()	Gets the human readable name of this function.
abstract Type[]	getGenericParameterTypes()
abstract String	getName()	Gets the method name.
abstract Annotation[][]	getParameterAnnotations()	Gets the annotations on parameters.
abstract String[]	getParameterNames()	Gets the list of parameter names.
abstract Class[]	getParameterTypes()	Gets the type of parameters in a single array.
abstract String	getQualifiedName()	Gets "className.methodName"
abstract Class	getReturnType()	Return type of the method.
abstract String	getSignature()	Gets the signature for this for use in lists
Object	invoke(StaplerRequest2 req, StaplerResponse2 rsp, Object o, Object... args)	Invokes the method.
Object	invoke(StaplerRequest req, StaplerResponse rsp, Object o, Object... args)	Deprecated. use invoke(StaplerRequest2, StaplerResponse2, Object, Object...)
abstract boolean	isStatic()	Returns true if and only if the function is static.
static Object	returnNull()

Methods inherited from class java.lang.Object

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

Constructor Details

Function

public Function()

Method Details

getName

public abstract String getName()

Gets the method name.

getDisplayName

public abstract String getDisplayName()

Gets the human readable name of this function. Used to assist debugging.

getSignature

public abstract String getSignature()

Gets the signature for this for use in lists

getQualifiedName

public abstract String getQualifiedName()

Gets "className.methodName"

getParameterTypes

public abstract Class[] getParameterTypes()

Gets the type of parameters in a single array.

getGenericParameterTypes

public abstract Type[] getGenericParameterTypes()

getParameterAnnotations

public abstract Annotation[][] getParameterAnnotations()

Gets the annotations on parameters.

getParameterNames

public abstract String[] getParameterNames()

Gets the list of parameter names.

getReturnType

public abstract Class getReturnType()

Return type of the method.

getCheckedExceptionTypes

public abstract Class[] getCheckedExceptionTypes()

Gets the type of checked exceptions.

Take care that RuntimeException can be checked but it's not mandatory

getDeclaringClass

public abstract Class getDeclaringClass()

Returns the Class object representing the class or interface that declares the executable represented by this object.

See Also:

• Member.getDeclaringClass()

isStatic

public abstract boolean isStatic()

Returns true if and only if the function is static.

contextualize

public Function contextualize(Object usage)

Caller uses this method to tell Function about how it is being used. By default, this methods ignores the given context by returning this.

returnNull

public static Object returnNull()

See Also:

• RETURN_NULL

invoke

public Object invoke(StaplerRequest2 req,
 StaplerResponse2 rsp,
 Object o,
 Object... args)
              throws IllegalAccessException,
InvocationTargetException,
jakarta.servlet.ServletException

Invokes the method.

Throws:

IllegalAccessException

InvocationTargetException

jakarta.servlet.ServletException

invoke

@Deprecated
public Object invoke(StaplerRequest req,
 StaplerResponse rsp,
 Object o,
 Object... args)
              throws IllegalAccessException,
InvocationTargetException,
javax.servlet.ServletException

Deprecated.

use invoke(StaplerRequest2, StaplerResponse2, Object, Object...)

Throws:

IllegalAccessException

InvocationTargetException

javax.servlet.ServletException

getAnnotation

public abstract <A extends Annotation> A getAnnotation(Class<A> annotation)

getAnnotations

public abstract Annotation[] getAnnotations()