public class XPathExtensionFunctionDescriptor
extends java.lang.Object
XPathExtensionFunctionPlugin
interface
and providing a service configuration file.
Modifier and Type | Class and Description |
---|---|
static class |
XPathExtensionFunctionDescriptor.ExpressionType
Used to express in what type of expressions and conditions this function is available.
|
static class |
XPathExtensionFunctionDescriptor.ParameterType
Enumeration to specify parameter and return types of a function.
|
Modifier and Type | Field and Description |
---|---|
static XPathExtensionFunctionDescriptor.ExpressionType[] |
ALL_EXPRESSION_TYPES
Constant containing all expression and condition types.
|
static java.lang.String |
COPYRIGHT |
Constructor and Description |
---|
XPathExtensionFunctionDescriptor(java.lang.String name,
java.lang.String namespace,
java.lang.String prefix,
java.lang.String className,
XPathExtensionFunctionDescriptor.ParameterType[] parameterTypes,
XPathExtensionFunctionDescriptor.ParameterType returnType,
XPathExtensionFunctionDescriptor.ExpressionType[] expressionTypes)
Constructor setting all members.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getClassName()
The Java class name that contains the implementation of this function.
|
XPathExtensionFunctionDescriptor.ExpressionType[] |
getExpressionTypes()
Specifies in what type of expressions and conditions this function will be available.
|
java.lang.String |
getName()
The name of the XPath function.
|
java.lang.String |
getNamespace()
The namespace of the XPath function.
|
XPathExtensionFunctionDescriptor.ParameterType[] |
getParameterTypes()
The parameter types of the XPath function.
|
java.lang.String |
getPrefix()
The namespace prefix used in the XPath expression or condition.
|
XPathExtensionFunctionDescriptor.ParameterType |
getReturnType()
The return type of the XPath function.
|
void |
setClassName(java.lang.String className)
Sets the class name of the Java implementation.
|
void |
setExpressionTypes(XPathExtensionFunctionDescriptor.ExpressionType[] expressionTypes)
Sets the expression types of the function.
|
void |
setName(java.lang.String name)
Sets the name of the XPath function.
|
void |
setNamespace(java.lang.String namespace)
Sets the XML namespace for the function.
|
void |
setParameterTypes(XPathExtensionFunctionDescriptor.ParameterType[] parameterTypes)
Sets the parameter types of the function.
|
void |
setPrefix(java.lang.String prefix)
Sets the XML prefix of the function.
|
void |
setReturnType(XPathExtensionFunctionDescriptor.ParameterType returnType)
Sets the return type of the function.
|
java.lang.String |
toString() |
public static final java.lang.String COPYRIGHT
public static final XPathExtensionFunctionDescriptor.ExpressionType[] ALL_EXPRESSION_TYPES
public XPathExtensionFunctionDescriptor(java.lang.String name, java.lang.String namespace, java.lang.String prefix, java.lang.String className, XPathExtensionFunctionDescriptor.ParameterType[] parameterTypes, XPathExtensionFunctionDescriptor.ParameterType returnType, XPathExtensionFunctionDescriptor.ExpressionType[] expressionTypes)
name
- The name of the function.namespace
- The XML namespace of the XPath function.prefix
- The XML namespace prefix, used for this function in the expression or condition.className
- The class name of the Java class that provides the functions implementation.parameterTypes
- The types of parametersreturnType
- The type of the return value.expressionTypes
- The types of expressions and conditions, where this function should be available.public java.lang.String getName()
public java.lang.String getPrefix()
public java.lang.String getClassName()
public XPathExtensionFunctionDescriptor.ExpressionType[] getExpressionTypes()
public java.lang.String getNamespace()
public XPathExtensionFunctionDescriptor.ParameterType[] getParameterTypes()
public XPathExtensionFunctionDescriptor.ParameterType getReturnType()
public void setName(java.lang.String name)
name
- The function name.public void setPrefix(java.lang.String prefix)
prefix
- The XML prefix.public void setClassName(java.lang.String className)
className
- The class name.public void setNamespace(java.lang.String namespace)
namespace
- The namespace.public void setReturnType(XPathExtensionFunctionDescriptor.ParameterType returnType)
returnType
- The return type.public void setParameterTypes(XPathExtensionFunctionDescriptor.ParameterType[] parameterTypes)
parameterTypes
- The types of the parameters.public void setExpressionTypes(XPathExtensionFunctionDescriptor.ExpressionType[] expressionTypes)
expressionTypes
- The expression types.public java.lang.String toString()
toString
in class java.lang.Object