Module dev.metaschema.core

Package dev.metaschema.core.metapath.function

Enum IFunction.FunctionProperty

java.lang.Object

java.lang.Enum<IFunction.FunctionProperty>

dev.metaschema.core.metapath.function.IFunction.FunctionProperty

All Implemented Interfaces:

Serializable, Comparable<IFunction.FunctionProperty>

Enclosing interface:

IFunction

public static enum IFunction.FunctionProperty
extends Enum<IFunction.FunctionProperty>

Details specific characteristics of a function.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTEXT_DEPENDENT	Indicates that the result of the function depends on property values within the static or dynamic context and the provided arguments (see XPath 3.1 context-dependent).
DETERMINISTIC	Indicates that the function will produce identical results for the same arguments (see XPath 3.1 deterministic).
FOCUS_DEPENDENT	Indicates that the result of the function depends on the current focus (see XPath 3.1 focus-dependent).
UNBOUNDED_ARITY	The function allows the last argument to be repeated any number of times.

Method Summary

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

DETERMINISTIC

public static final IFunction.FunctionProperty DETERMINISTIC

Indicates that the function will produce identical results for the same arguments (see XPath 3.1 deterministic). If not assigned to a function definition, a function call with the same arguments is not guaranteed to produce the same results in the same order for subsequent calls within the same execution context.

CONTEXT_DEPENDENT

public static final IFunction.FunctionProperty CONTEXT_DEPENDENT

Indicates that the result of the function depends on property values within the static or dynamic context and the provided arguments (see XPath 3.1 context-dependent). If not assigned to a function definition, a call will not be affected by the property values within the static or dynamic context and will not have any arguments.

FOCUS_DEPENDENT

public static final IFunction.FunctionProperty FOCUS_DEPENDENT

Indicates that the result of the function depends on the current focus (see XPath 3.1 focus-dependent). If not assigned to a function definition, a call will not be affected by the current focus.

UNBOUNDED_ARITY

public static final IFunction.FunctionProperty UNBOUNDED_ARITY

The function allows the last argument to be repeated any number of times.

Method Details

values

public static IFunction.FunctionProperty[] values()

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

Returns:

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

valueOf

public static IFunction.FunctionProperty 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