Module dev.metaschema.core
Package dev.metaschema.core.metapath.function

Interface IFunctionLibrary

All Known Implementing Classes:
DefaultFunctionLibrary, FunctionLibrary
public interface IFunctionLibrary
Provides access to a collection of Metapath function signatures.

  • Method Summary

    Modifier and Type
    Method
    Description
    IFunction
    getFunction(IEnhancedQName name, int arity)
    Retrieve the function with the provided namespace qualified name that supports the signature of the provided arity, if such a function exists.
    default boolean
    hasFunction(IEnhancedQName name, int arity)
    Determine if there is a function with the provided namespace qualified name that supports the signature of the provided arity.
    Stream<IFunction>
    stream()
    Retrieve the collection of function signatures in this library as a stream.

  • Method Details

    • stream

      @NonNull Stream<IFunction> stream()
      Retrieve the collection of function signatures in this library as a stream.
      Returns:
      a stream of function signatures

    • hasFunction

      default boolean hasFunction(@NonNull IEnhancedQName name, int arity)
      Determine if there is a function with the provided namespace qualified name that supports the signature of the provided arity.
      Parameters:
      name - the namespace qualified name of a group of functions
      arity - the count of arguments for use in determining an argument signature match
      Returns:
      true if a function signature matches or false otherwise

    • getFunction

      IFunction getFunction(@NonNull IEnhancedQName name, int arity)
      Retrieve the function with the provided namespace qualified name that supports the signature of the provided arity, if such a function exists.
      Parameters:
      name - the namespace qualified name of a group of functions
      arity - the count of arguments for use in determining an argument signature match
      Returns:
      the matching function or null if no match exists