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

Enum XPathVersion

java.lang.Object

java.lang.Enum<XPathVersion>

net.sourceforge.pmd.lang.rule.xpath.XPathVersion

All Implemented Interfaces:

Serializable, Comparable<XPathVersion>

public enum XPathVersion
extends Enum<XPathVersion>

Constants for XPath language version used in XPath queries.

Enum Constant Summary

Enum Constants

Enum Constant	Description
XPATH_1_0	Deprecated. Will become unsupported in 7.0.0
XPATH_1_0_COMPATIBILITY	Deprecated. Will become unsupported in 7.0.0
XPATH_2_0	XPath 2.0.

Method Summary

Modifier and Type	Method	Description
String	getXmlName()	Returns the string used to represent the version in the XML.
static XPathVersion	ofId(String version)	Gets an XPath version from the string used to represent it in the XML.
static XPathVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XPathVersion[]	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

XPATH_1_0

@Deprecated
public static final XPathVersion XPATH_1_0

Deprecated.

Will become unsupported in 7.0.0

XPath 1.0.

XPATH_1_0_COMPATIBILITY

@Deprecated
public static final XPathVersion XPATH_1_0_COMPATIBILITY

Deprecated.

Will become unsupported in 7.0.0

XPath 1.0 compatibility mode.

XPATH_2_0

public static final XPathVersion XPATH_2_0

XPath 2.0.

Method Detail

values

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

Returns:

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

valueOf

public static XPathVersion 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

getXmlName

public String getXmlName()

Returns the string used to represent the version in the XML.

Returns:

A string representation

ofId

public static XPathVersion ofId(String version)

Gets an XPath version from the string used to represent it in the XML.

Parameters:

version - A version string

Returns:

An XPath version, or null if the argument is not a valid version