Package net.sourceforge.pmd.lang.rule.xpath.impl

Enum XPathFunctionDefinition.Type

java.lang.Object

java.lang.Enum<XPathFunctionDefinition.Type>

net.sourceforge.pmd.lang.rule.xpath.impl.XPathFunctionDefinition.Type

All Implemented Interfaces:

Serializable, Comparable<XPathFunctionDefinition.Type>

Enclosing class:

XPathFunctionDefinition

public static enum XPathFunctionDefinition.Type
extends Enum<XPathFunctionDefinition.Type>

Supported types of a custom XPath function. These can be used as result types or argument types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
OPTIONAL_DECIMAL	Represents a Optional Double.
OPTIONAL_STRING	Represents a Optional String.
SINGLE_BOOLEAN	Represents Boolean.
SINGLE_ELEMENT	Represents any node.
SINGLE_INTEGER	Represents Integer.
SINGLE_STRING	Represents String.
STRING_SEQUENCE	Represents a List of String, potentially empty.

Method Summary

Modifier and Type	Method	Description
static XPathFunctionDefinition.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XPathFunctionDefinition.Type[]	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

SINGLE_STRING

public static final XPathFunctionDefinition.Type SINGLE_STRING

Represents String.

SINGLE_BOOLEAN

public static final XPathFunctionDefinition.Type SINGLE_BOOLEAN

Represents Boolean.

SINGLE_INTEGER

public static final XPathFunctionDefinition.Type SINGLE_INTEGER

Represents Integer.

SINGLE_ELEMENT

public static final XPathFunctionDefinition.Type SINGLE_ELEMENT

Represents any node. Usually used as an argument type.

STRING_SEQUENCE

public static final XPathFunctionDefinition.Type STRING_SEQUENCE

Represents a List of String, potentially empty.

OPTIONAL_STRING

public static final XPathFunctionDefinition.Type OPTIONAL_STRING

Represents a Optional String.

OPTIONAL_DECIMAL

public static final XPathFunctionDefinition.Type OPTIONAL_DECIMAL

Represents a Optional Double.

Method Detail

values

public static XPathFunctionDefinition.Type[] 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 (XPathFunctionDefinition.Type c : XPathFunctionDefinition.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static XPathFunctionDefinition.Type valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null