Module pro.verron.officestamper

Package pro.verron.officestamper.api

Record Class CustomFunction

java.lang.Object

java.lang.Record

pro.verron.officestamper.api.CustomFunction

Record Components:

name - the name of the function

parameterTypes - the parameter types expected by the function

function - the implementation of the function that accepts a list of arguments and produces a result

public record CustomFunction(String name, List<Class<?>> parameterTypes, Function<List<Object>,Object> function)
extends Record

Represents a custom function encapsulating a name, parameter types, and a functional implementation. This record provides a structure for defining and handling generic functions with dynamic argument types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomFunction.NeedsBiFunctionImpl<T,U>	Represents a contract for classes that require the implementation of a BiFunction.
static interface	CustomFunction.NeedsFunctionImpl<T>	The NeedsFunctionImpl interface specifies a contract for classes that require the implementation of a function that operates on a specific type and produces a result.
static interface	CustomFunction.NeedsTriFunctionImpl<T,U,V>	Represents a contract for classes requiring the implementation of a TriFunction.

Constructor Summary

Constructors

Constructor	Description
CustomFunction(String name, List<Class<?>> parameterTypes, Function<List<Object>,Object> function)	Creates an instance of a CustomFunction record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Function<List<Object>,Object>	function()	Returns the value of the function record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
List<Class<?>>	parameterTypes()	Returns the value of the parameterTypes record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CustomFunction

public CustomFunction(String name,
 List<Class<?>> parameterTypes,
 Function<List<Object>,Object> function)

Creates an instance of a CustomFunction record class.

Parameters:

name - the value for the name record component

parameterTypes - the value for the parameterTypes record component

function - the value for the function record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

parameterTypes

public List<Class<?>> parameterTypes()

Returns the value of the parameterTypes record component.

Returns:

the value of the parameterTypes record component

function

public Function<List<Object>,Object> function()

Returns the value of the function record component.

Returns:

the value of the function record component