Package jakarta.el

Class FunctionMapper

  • Direct Known Subclasses:
    FunctionMapperFactory, FunctionMapperImpl, StandardELContext.DefaultFunctionMapper
    public abstract class FunctionMapper
extends java.lang.Object
    The interface to a map between Jakarta Expression Language function names and methods.

    A FunctionMapper maps ${prefix:name()} style functions to a static method that can execute that function.

    Since:
    Jakarta Server Pages 2.1

    • Constructor Summary

      Constructors 
      Constructor Description
      FunctionMapper()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void mapFunction​(java.lang.String prefix, java.lang.String localName, java.lang.reflect.Method meth)
      Adds a static method that can be used as a function.
      abstract java.lang.reflect.Method resolveFunction​(java.lang.String prefix, java.lang.String localName)
      Resolves the specified prefix and local name into a java.lang.Method.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FunctionMapper

        public FunctionMapper()

    • Method Detail

      • resolveFunction

        public abstract java.lang.reflect.Method resolveFunction​(java.lang.String prefix,
                                                         java.lang.String localName)
        Resolves the specified prefix and local name into a java.lang.Method.

        Returns null if no function could be found that matches the given prefix and local name.

        Parameters:
        prefix - the prefix of the function, or "" if no prefix. For example, "fn" in ${fn:method()}, or "" in ${method()}.
        localName - the short name of the function. For example, "method" in ${fn:method()}.
        Returns:
        the static method to invoke, or null if no match was found.

      • mapFunction

        public void mapFunction​(java.lang.String prefix,
                        java.lang.String localName,
                        java.lang.reflect.Method meth)
        Adds a static method that can be used as a function.
        Parameters:
        prefix - the prefix of the function, or "" if no prefix. For example, "fn" in ${fn:method()}, or "" in ${method()}.
        localName - the short name of the function. For example, "method" in ${fn:method()}.
        meth - The static method that is to be invoked, when the function is referenced. The null value causes the function to be removed from the map.
        Since:
        Jakarta Expression Language 3.0