Interface InterceptorMethod

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface InterceptorMethod

A representation of a Jakarta Interceptors interceptor method.

Author:

Laird Nelson

Method Summary

Modifier and Type	Method	Description
Object	intercept(InvocationContext ic)	Performs interception and returns any result.
static InterceptorMethod	of(MethodHandle receiverlessOrBoundMethodHandle)	Returns a new InterceptorMethod that adapts the supplied receiverless or bound MethodHandle.
static InterceptorMethod	of(MethodHandle mh, Supplier<?> receiverSupplier)	Returns a new InterceptorMethod that adapts the supplied MethodHandle and the supplied Supplier of its receiver.
static InterceptorMethod	of(MethodHandles.Lookup lookup, Method staticMethod)	Returns a new InterceptorMethod that adapts the supplied static Method.
static InterceptorMethod	of(MethodHandles.Lookup lookup, Method m, Supplier<?> targetSupplier)	Returns a new InterceptorMethod that adapts the supplied Method and the supplied Supplier of its receiver.

Method Details

intercept

Object intercept(InvocationContext ic)
          throws Exception

Performs interception and returns any result.

Parameters:

ic - an InvocationContext; must not be null

Returns:

the result of interception, often computed by invoking the InvocationContext.proceed() method; the return value may be null

Throws:

Exception - if any error occurs

of

static InterceptorMethod of(MethodHandles.Lookup lookup,
 Method staticMethod)
                     throws IllegalAccessException

Returns a new InterceptorMethod that adapts the supplied static Method.

Parameters:

lookup - a MethodHandles.Lookup; must not be null

staticMethod - a static Method; must not be null; must accept exactly one InvocationContext-typed argument

Returns:

a new InterceptorMethod; never null

Throws:

NullPointerException - if lookup or staticMethod is null

IllegalAccessException - if unreflecting fails

See Also:

• of(Lookup, Method, Supplier)
• of(MethodHandle, Supplier)

of

static InterceptorMethod of(MethodHandles.Lookup lookup,
 Method m,
 Supplier<?> targetSupplier)
                     throws IllegalAccessException

Returns a new InterceptorMethod that adapts the supplied Method and the supplied Supplier of its receiver.

Parameters:

lookup - a MethodHandles.Lookup; must not be null

m - a Method; must not be null; must accept exactly one InvocationContext-typed argument

targetSupplier - a Supplier of the supplied Method's receiver; often memoized; may be null in which case the supplied Method must be static

Returns:

a new InterceptorMethod; never null

Throws:

NullPointerException - if lookup or m is null

IllegalAccessException - if unreflecting fails

See Also:

• of(MethodHandle, Supplier)

of

static InterceptorMethod of(MethodHandle receiverlessOrBoundMethodHandle)

Returns a new InterceptorMethod that adapts the supplied receiverless or bound MethodHandle.

Parameters:

receiverlessOrBoundMethodHandle - a MethodHandle; must not be null; must either not require a receiver or must be already bound to one; must accept exactly one InvocationContext-typed argument

Returns:

a new InterceptorMethod; never null

Throws:

NullPointerException - if receiverlessOrBoundMethodHandle is null

See Also:

• of(MethodHandle, Supplier)

of

static InterceptorMethod of(MethodHandle mh,
 Supplier<?> receiverSupplier)

Returns a new InterceptorMethod that adapts the supplied MethodHandle and the supplied Supplier of its receiver.

Parameters:

mh - a MethodHandle; must not be null; must either accept two arguments where the first argument's type is a valid receiver type and the second argument's type is InvocationContext, or one argument whose type is InvocationContext

receiverSupplier - a Supplier of the supplied MethodHandle's receiver; often memoized; may be null in which case the supplied MethodHandle must either not require a receiver or must be already bound to one

Returns:

a new InterceptorMethod; never null

Throws:

NullPointerException - if m is null