org.basex.query.func

Enum Variable

java.lang.Object

java.lang.Enum<Variable>

org.basex.query.func.Variable

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Variable>

public enum Variable
extends java.lang.Enum<Variable>

Statically available XQuery variables.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILEDIRSEP File variable.
FILEPATHSEP File variable.
XSLTPROC XSLT variable.
XSLTVERSION XSLT variable.

Method Summary

Methods

Modifier and Type	Method and Description
static void	init(QueryContext ctx) Initializes all variables.
java.lang.String	toString()
static Variable	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Variable[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FILEDIRSEP

public static final Variable FILEDIRSEP

File variable.

FILEPATHSEP

public static final Variable FILEPATHSEP

File variable.

XSLTPROC

public static final Variable XSLTPROC

XSLT variable.

XSLTVERSION

public static final Variable XSLTVERSION

XSLT variable.

Method Detail

values

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

Returns:

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

valueOf

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

init

public static void init(QueryContext ctx)

Initializes all variables.

Parameters:

ctx - query context

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Variable>