Class FunctionXML_OPEN

    • Field Detail

      • RES_XML_DOC_PREFIX

        public static final java.lang.String RES_XML_DOC_PREFIX
        See Also:
        Constant Field Values
      • RES_XML_ELEMENT_PREFIX

        public static final java.lang.String RES_XML_ELEMENT_PREFIX
        See Also:
        Constant Field Values
      • ARG_TYPES

        private static final ValueType[][] ARG_TYPES
    • Constructor Detail

      • FunctionXML_OPEN

        public FunctionXML_OPEN()
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: AbstractFunction
        Get the function name
        Specified by:
        getName in class AbstractFunction
        Returns:
        the function name in lower case, must not be null
      • openFileAndParse

        private org.w3c.dom.Document openFileAndParse​(PreprocessorContext context,
                                                      java.io.File file)
      • getArity

        public int getArity()
        Description copied from class: AbstractFunction
        Get the function arity
        Specified by:
        getArity in class AbstractFunction
        Returns:
        the function arity (zero or greater)
      • getAllowedArgumentTypes

        public ValueType[][] getAllowedArgumentTypes()
        Description copied from class: AbstractFunction
        Get arrays of supported argument types
        Specified by:
        getAllowedArgumentTypes in class AbstractFunction
        Returns:
        the array of argument type combinations allowed by the function handler, must not be null
      • getReference

        public java.lang.String getReference()
        Description copied from class: AbstractFunction
        Get the function reference to be output for a help request
        Specified by:
        getReference in class AbstractFunction
        Returns:
        the function information as a String, must not be null