IBM WebSphere Application ServerTM
Release 8

com.ibm.bpe.xpath.spi
Enum XPathExtensionFunctionDescriptor.ParameterType

java.lang.Object
  extended by java.lang.Enum<XPathExtensionFunctionDescriptor.ParameterType>
      extended by com.ibm.bpe.xpath.spi.XPathExtensionFunctionDescriptor.ParameterType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<XPathExtensionFunctionDescriptor.ParameterType>
Enclosing class:
XPathExtensionFunctionDescriptor

public static enum XPathExtensionFunctionDescriptor.ParameterType
extends java.lang.Enum<XPathExtensionFunctionDescriptor.ParameterType>

Enumeration to specify parameter and return types of a function. The table shows how the defined parameter types map to XPath and Java types:

Parameter Type XPath Type Java Type
Object Node commonj.sdo.DataObject
NODE_SET node-set java.util.List
BOOLEAN boolean java.lang.Boolean or boolean
STRING string java.lang.String
NUMBER number java.lang.Number including any sub-classes, such as: Integer or int.


Enum Constant Summary
BOOLEAN
          Specifies that a parameter or return type is a boolean.
NODE_SET
          Specifies that a parameter or return type is a node-set.
NUMBER
          Specifies that a parameter or return type is a number.
OBJECT
          Specifies that a parameter or return type is a complex object.
STRING
          Specifies that a parameter or return type is a string.
 
Method Summary
static XPathExtensionFunctionDescriptor.ParameterType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static XPathExtensionFunctionDescriptor.ParameterType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NODE_SET

public static final XPathExtensionFunctionDescriptor.ParameterType NODE_SET
Specifies that a parameter or return type is a node-set. This maps to Java type java.util.List.


BOOLEAN

public static final XPathExtensionFunctionDescriptor.ParameterType BOOLEAN
Specifies that a parameter or return type is a boolean. This maps to Java type Boolean of boolean.


STRING

public static final XPathExtensionFunctionDescriptor.ParameterType STRING
Specifies that a parameter or return type is a string. This maps to Java type String.


NUMBER

public static final XPathExtensionFunctionDescriptor.ParameterType NUMBER
Specifies that a parameter or return type is a number. This maps to Java type Number or any sub-type.


OBJECT

public static final XPathExtensionFunctionDescriptor.ParameterType OBJECT
Specifies that a parameter or return type is a complex object. This maps to Java type commonj.sdo.DataObject.

Method Detail

values

public static XPathExtensionFunctionDescriptor.ParameterType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (XPathExtensionFunctionDescriptor.ParameterType c : XPathExtensionFunctionDescriptor.ParameterType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static XPathExtensionFunctionDescriptor.ParameterType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

IBM WebSphere Application ServerTM
Release 8