org.kohsuke.stapler

Class ForwardingFunction

java.lang.Object

org.kohsuke.stapler.Function

org.kohsuke.stapler.ForwardingFunction

public class ForwardingFunction
extends Function

Function that forwards calls to another. Usually used as a basis of decorator.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class org.kohsuke.stapler.Function

Function.InstanceFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected Function	next

Constructor Summary

Constructors

Constructor and Description
ForwardingFunction(Function next)

Method Summary

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

Methods inherited from class org.kohsuke.stapler.Function

returnNull

Methods inherited from class java.lang.Object

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

Field Detail

next

protected final Function next

Constructor Detail

ForwardingFunction

public ForwardingFunction(Function next)

Method Detail

getName

public String getName()

Description copied from class: Function

Gets the method name.

Specified by:

getName in class Function

getDisplayName

public String getDisplayName()

Description copied from class: Function

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

Specified by:

getDisplayName in class Function

isStatic

public boolean isStatic()

Description copied from class: Function

Returns true if and only if the function is static.

Specified by:

isStatic in class Function

Returns:

getQualifiedName

public String getQualifiedName()

Description copied from class: Function

Gets "className.methodName"

Specified by:

getQualifiedName in class Function

getParameterTypes

public Class[] getParameterTypes()

Description copied from class: Function

Gets the type of parameters in a single array.

Specified by:

getParameterTypes in class Function

getReturnType

public Class getReturnType()

Description copied from class: Function

Return type of the method.

Specified by:

getReturnType in class Function

getCheckedExceptionTypes

public Class[] getCheckedExceptionTypes()

Description copied from class: Function

Gets the type of checked exceptions.

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

Specified by:

getCheckedExceptionTypes in class Function

getDeclaringClass

public Class getDeclaringClass()

Description copied from class: Function

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

Specified by:

getDeclaringClass in class Function

See Also:

Member.getDeclaringClass()

contextualize

public Function contextualize(Object usage)

Description copied from class: Function

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

Overrides:

contextualize in class Function

getGenericParameterTypes

public Type[] getGenericParameterTypes()

Specified by:

getGenericParameterTypes in class Function

getSignature

public String getSignature()

Description copied from class: Function

Gets the signature for this for use in lists

Specified by:

getSignature in class Function

getParameterAnnotations

public Annotation[][] getParameterAnnotations()

Description copied from class: Function

Gets the annotations on parameters.

Specified by:

getParameterAnnotations in class Function

getParameterNames

public String[] getParameterNames()

Description copied from class: Function

Gets the list of parameter names.

Specified by:

getParameterNames in class Function

invoke

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

Description copied from class: Function

Invokes the method.

Specified by:

invoke in class Function

Throws:

IllegalAccessException

InvocationTargetException

javax.servlet.ServletException

getAnnotation

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

Specified by:

getAnnotation in class Function

getAnnotations

public Annotation[] getAnnotations()

Specified by:

getAnnotations in class Function