BeanMethod<T extends Object> class final

The description of one public instance method of an introspected class or bean, with a closure that calls it.

SpEL uses it to call methods on introspected objects, and frameworks use the ones in BeanDefinition.annotatedMethods to call annotated methods of beans (@Scheduled, request handlers). You write one by hand only in a hand-written introspection.

// Person.hello(String name), called by name from an expression.
final hello = BeanMethod<Person>(
  'hello',
  returnType: String,
  parameterTypes: const [String],
  invoke: (b, args) => b.hello(args.first! as String),
);
hello.invoke(person, ['Ann']);

Spring (Java): java.lang.reflect.Method:

Method hello = Person.class.getMethod("hello", String.class);
hello.invoke(person, "Ann");

Constructors

BeanMethod(String name, {required Object? invoke(T bean, List<Object?> arguments), Object? invokeNamed(T bean, List<Object?> positional, Map<Symbol, Object?> named)?, Type? returnType, List<Type> parameterTypes = const [], List<BeanParameter> parameters = const [], TypeInfo<Object?>? returnTypeInfo, bool isFuture = false, bool isVoid = false, List<Object> annotations = const []})

Describes the method name of T, called through invoke (and invokeNamed when it has named parameters).

Properties

annotations → List<Object>

The const annotations on the method.

final

hashCode → int

The hash code for this object.

no setter, inherited

isFuture → bool

Whether the method returns a non-nullable Future (see returnTypeInfo).

final

isVoid → bool

Whether the result (or the future's value) is void.

final

name → String

The method's name.

final

parameters → List<BeanParameter>

Every parameter (positional, then named) with its name, full type and annotations. Written by the generator for the methods of BeanDefinition.annotatedMethods (what a request handler needs to bind its arguments); empty in other descriptions.

final

parameterTypes → List<Type>

Declared types of the positional parameters.

final

returnType → Type?

The declared return type; null for void.

final

returnTypeInfo → TypeInfo<Object?>?

The full result type, for a Future<T> the type T (what a request handler's answer is converted from). Written by the generator for every method of BeanDefinition.annotatedMethods that returns a value, with or without parameters; null for a void method (see isVoid) and in other descriptions.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

annotation<A>() → A?

The first annotation of type A on the method, or null.

appliesTo(Object bean) → bool

Whether bean can be passed to invoke: an instance of T. A proxy that implements only the bean's interfaces (aop_proxies: interfaces) is not; call the method on AopUtils.getTarget(bean) then.

invoke(Object bean, List<Object?> arguments, [Map<Symbol, Object?> namedArguments = const {}]) → Object?

Calls the method on bean with positional arguments (already of the parameter types) and namedArguments (by BeanParameter.symbol; an omitted optional one keeps its default value); returns its result (null for void). Throws ArgumentError when named arguments are given to a method described without them.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited