Package com.storedobject.common

Interface MethodInvoker

All Known Implementing Classes:

CustomMethodInvoker, SerialNumberMethodInvoker, SimpleMethodInvoker, StoredObjectUtility.MethodList, StyledMethodInvoker

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 MethodInvoker

A functional interface designed for invoking a method on a given object. It provides additional utility methods for obtaining information about the method and formatting the result.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default Function<Object,?>	function()	Creates a Function that applies the invoke method to a given object.
default Function<Object,?>	function(boolean logError)	Creates a Function that applies the invoke method to a given object, with an optional logging behavior for errors during method invocation.
default String	getAttributeName()	Retrieves the name of an attribute associated with this method.
default Class<?>	getReturnType()	Determines the return type of the `invoke` method defined in the implementing class.
default Method	getTail()	Retrieves the tail method associated with the implementation.
Object	invoke(Object object)	Invokes a method on the provided object.
default Object	invoke(Object object, boolean logError)	Invokes a method on the provided object with an optional logging behavior for errors.
default Function<Object,String>	string()	Creates a Function that takes an Object as input and converts the result of invoking a method on the object into a String.
default Function<Object,String>	string(boolean logError)	Creates a Function that takes an Object as input, applies the invoke method to the input object with an optional logging behavior for errors, and converts the result into a String.

Method Details

getAttributeName

default String getAttributeName()

Retrieves the name of an attribute associated with this method.

Returns:

a string representing the attribute name, or null if no attribute name is defined.

getTail

default Method getTail()

Retrieves the tail method associated with the implementation. The tail method typically represents an additional or final processing method in the context of the functional interface's behavior.

Returns:

the Method instance representing the tail method, or null if no such method is defined.

invoke

Object invoke(Object object)

Invokes a method on the provided object.

Parameters:

object - the object on which the method is to be invoked

Returns:

the result of the method invocation, or null if the invocation fails

getReturnType

default Class<?> getReturnType()

Determines the return type of the `invoke` method defined in the implementing class. If the `invoke` method cannot be located or an exception occurs, defaults to returning String.class.

Returns:

the Class object representing the return type of the `invoke` method or String.class if the method is not found or an error occurs.

invoke

default Object invoke(Object object,
 boolean logError)

Invokes a method on the provided object with an optional logging behavior for errors.

Parameters:

object - the object on which the method is to be invoked

logError - a boolean flag indicating whether errors during invocation should be logged

Returns:

the result of the method invocation, or null if the invocation fails

function

default Function<Object,?> function()

Creates a Function that applies the invoke method to a given object. This version of the function() method does not log errors during invocation.

Returns:

a Function that takes an Object as input and produces a result by invoking the invoke method on the input object without logging errors.

function

default Function<Object,?> function(boolean logError)

Creates a Function that applies the invoke method to a given object, with an optional logging behavior for errors during method invocation.

Parameters:

logError - a boolean flag indicating whether errors during invocation should be logged

Returns:

a Function that takes an Object as input and produces a result by invoking the invoke method on the input object, with error logging behavior determined by the logError parameter

string

default Function<Object,String> string()

Creates a Function that takes an Object as input and converts the result of invoking a method on the object into a String. This method does not log errors during the invocation process.

Returns:

a Function that applies the invoke method to a given object, converts the result to a String, and does not log errors during the process.

string

default Function<Object,String> string(boolean logError)

Creates a Function that takes an Object as input, applies the invoke method to the input object with an optional logging behavior for errors, and converts the result into a String.

Parameters:

logError - a boolean flag indicating whether errors during invocation should be logged

Returns:

a Function that applies the invoke method to the input object, converts the result to a String, with error logging behavior determined by the logError parameter