Class FunctionXML_GET

java.lang.Object

com.igormaznitsa.jcp.expression.functions.AbstractFunction

com.igormaznitsa.jcp.expression.functions.xml.AbstractXMLFunction

com.igormaznitsa.jcp.expression.functions.xml.FunctionXML_GET

All Implemented Interfaces:

ExpressionItem

public final class FunctionXML_GET
extends AbstractXMLFunction

The class implements the xml_get function handler

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Field Summary

Fields inherited from class AbstractFunction

ALL_FUNCTIONS, EXECUTION_PREFIX, FUNCTION_NAME_MAP, UID_COUNTER

Constructor Summary

Constructors

Constructor	Description
FunctionXML_GET()

Method Summary

Modifier and Type	Method	Description
Value	executeStrInt(PreprocessorContext context, Value elementListId, Value elementIndex)
ValueType[][]	getAllowedArgumentTypes()	Get arrays of supported argument types
int	getArity()	Get the function arity
String	getName()	Get the function name
String	getReference()	Get the function reference to be output for a help request
ValueType	getResultType()	Get the result type

Methods inherited from class AbstractXMLFunction

buildPathForElement, findCachedElement, findCachedElementList, findElementForIndex, getAttribute, getCachedDocument, getCachedElement, getCachedElementList, getElementListSize, getFirstLevelTextContent, makeDocumentId, makeDocumentRootId, makeElementId, makeElementListId, makeXPathElementId, makeXPathListId

Methods inherited from class AbstractFunction

findForClass, findForName, getExpressionItemPriority, getExpressionItemType, toString

Methods inherited from class Object

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

Constructor Details

FunctionXML_GET

public FunctionXML_GET()

Method Details

getName

public 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

executeStrInt

public Value executeStrInt(PreprocessorContext context,
 Value elementListId,
 Value elementIndex)

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

@MustNotContainNull
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 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

getResultType

public ValueType getResultType()

Description copied from class: AbstractFunction

Get the result type

Specified by:

getResultType in class AbstractFunction

Returns:

the result type of the function, must not be null