Package org.basex.query.func
Enum ApiFunction
- java.lang.Object
-
- java.lang.Enum<ApiFunction>
-
- org.basex.query.func.ApiFunction
-
- All Implemented Interfaces:
Serializable
,Comparable<ApiFunction>
,AFunction
public enum ApiFunction extends Enum<ApiFunction> implements AFunction
Definitions of all built-in XQuery functions. New namespace mappings for function prefixes and URIs must be added to the static initializer of theNSGlobal
class.- Author:
- BaseX Team 2005-23, BSD License, Christian Gruen
-
-
Enum Constant Summary
Enum Constants Enum Constant Description _REQUEST_ADDRESS
XQuery function._REQUEST_ATTRIBUTE
XQuery function._REQUEST_ATTRIBUTE_NAMES
XQuery function._REQUEST_CONTEXT_PATH
XQuery function._REQUEST_COOKIE
XQuery function._REQUEST_COOKIE_NAMES
XQuery function._REQUEST_HEADER
XQuery function._REQUEST_HEADER_NAMES
XQuery function._REQUEST_HOSTNAME
XQuery function._REQUEST_METHOD
XQuery function._REQUEST_PARAMETER
XQuery function._REQUEST_PARAMETER_NAMES
XQuery function._REQUEST_PATH
XQuery function._REQUEST_PORT
XQuery function._REQUEST_QUERY
XQuery function._REQUEST_REMOTE_ADDRESS
XQuery function._REQUEST_REMOTE_HOSTNAME
XQuery function._REQUEST_REMOTE_PORT
XQuery function._REQUEST_SCHEME
XQuery function._REQUEST_SET_ATTRIBUTE
XQuery function._REQUEST_URI
XQuery function._RESTXQ_BASE_URI
XQuery function._RESTXQ_INIT
XQuery function._RESTXQ_URI
XQuery function._RESTXQ_WADL
XQuery function._SESSION_ACCESSED
XQuery function._SESSION_CLIENT_ID
XQuery function._SESSION_CLOSE
XQuery function._SESSION_CREATED
XQuery function._SESSION_DELETE
XQuery function._SESSION_GET
XQuery function._SESSION_ID
XQuery function._SESSION_NAMES
XQuery function._SESSION_SET
XQuery function._SESSIONS_ACCESSED
XQuery function._SESSIONS_CLOSE
XQuery function._SESSIONS_CREATED
XQuery function._SESSIONS_DELETE
XQuery function._SESSIONS_GET
XQuery function._SESSIONS_IDS
XQuery function._SESSIONS_NAMES
XQuery function._SESSIONS_SET
XQuery function._WS_BROADCAST
XQuery function._WS_CLOSE
XQuery function._WS_DELETE
XQuery function._WS_EMIT
XQuery function._WS_EVAL
XQuery function._WS_GET
XQuery function._WS_ID
XQuery function._WS_IDS
XQuery function._WS_PATH
XQuery function._WS_SEND
XQuery function._WS_SET
XQuery function.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FuncDefinition
definition()
static void
init(ArrayList<FuncDefinition> list)
Adds function signatures to the list.String
toString()
static ApiFunction
valueOf(String name)
Returns the enum constant of this type with the specified name.static ApiFunction[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
_REQUEST_ADDRESS
public static final ApiFunction _REQUEST_ADDRESS
XQuery function.
-
_REQUEST_ATTRIBUTE
public static final ApiFunction _REQUEST_ATTRIBUTE
XQuery function.
-
_REQUEST_ATTRIBUTE_NAMES
public static final ApiFunction _REQUEST_ATTRIBUTE_NAMES
XQuery function.
-
_REQUEST_CONTEXT_PATH
public static final ApiFunction _REQUEST_CONTEXT_PATH
XQuery function.
-
_REQUEST_COOKIE
public static final ApiFunction _REQUEST_COOKIE
XQuery function.
-
_REQUEST_COOKIE_NAMES
public static final ApiFunction _REQUEST_COOKIE_NAMES
XQuery function.
-
_REQUEST_HEADER
public static final ApiFunction _REQUEST_HEADER
XQuery function.
-
_REQUEST_HEADER_NAMES
public static final ApiFunction _REQUEST_HEADER_NAMES
XQuery function.
-
_REQUEST_HOSTNAME
public static final ApiFunction _REQUEST_HOSTNAME
XQuery function.
-
_REQUEST_METHOD
public static final ApiFunction _REQUEST_METHOD
XQuery function.
-
_REQUEST_PARAMETER
public static final ApiFunction _REQUEST_PARAMETER
XQuery function.
-
_REQUEST_PARAMETER_NAMES
public static final ApiFunction _REQUEST_PARAMETER_NAMES
XQuery function.
-
_REQUEST_PATH
public static final ApiFunction _REQUEST_PATH
XQuery function.
-
_REQUEST_PORT
public static final ApiFunction _REQUEST_PORT
XQuery function.
-
_REQUEST_QUERY
public static final ApiFunction _REQUEST_QUERY
XQuery function.
-
_REQUEST_REMOTE_ADDRESS
public static final ApiFunction _REQUEST_REMOTE_ADDRESS
XQuery function.
-
_REQUEST_REMOTE_HOSTNAME
public static final ApiFunction _REQUEST_REMOTE_HOSTNAME
XQuery function.
-
_REQUEST_REMOTE_PORT
public static final ApiFunction _REQUEST_REMOTE_PORT
XQuery function.
-
_REQUEST_SCHEME
public static final ApiFunction _REQUEST_SCHEME
XQuery function.
-
_REQUEST_SET_ATTRIBUTE
public static final ApiFunction _REQUEST_SET_ATTRIBUTE
XQuery function.
-
_REQUEST_URI
public static final ApiFunction _REQUEST_URI
XQuery function.
-
_RESTXQ_BASE_URI
public static final ApiFunction _RESTXQ_BASE_URI
XQuery function.
-
_RESTXQ_INIT
public static final ApiFunction _RESTXQ_INIT
XQuery function.
-
_RESTXQ_URI
public static final ApiFunction _RESTXQ_URI
XQuery function.
-
_RESTXQ_WADL
public static final ApiFunction _RESTXQ_WADL
XQuery function.
-
_SESSION_ACCESSED
public static final ApiFunction _SESSION_ACCESSED
XQuery function.
-
_SESSION_CLIENT_ID
public static final ApiFunction _SESSION_CLIENT_ID
XQuery function.
-
_SESSION_CLOSE
public static final ApiFunction _SESSION_CLOSE
XQuery function.
-
_SESSION_CREATED
public static final ApiFunction _SESSION_CREATED
XQuery function.
-
_SESSION_DELETE
public static final ApiFunction _SESSION_DELETE
XQuery function.
-
_SESSION_GET
public static final ApiFunction _SESSION_GET
XQuery function.
-
_SESSION_ID
public static final ApiFunction _SESSION_ID
XQuery function.
-
_SESSION_NAMES
public static final ApiFunction _SESSION_NAMES
XQuery function.
-
_SESSION_SET
public static final ApiFunction _SESSION_SET
XQuery function.
-
_SESSIONS_ACCESSED
public static final ApiFunction _SESSIONS_ACCESSED
XQuery function.
-
_SESSIONS_CLOSE
public static final ApiFunction _SESSIONS_CLOSE
XQuery function.
-
_SESSIONS_CREATED
public static final ApiFunction _SESSIONS_CREATED
XQuery function.
-
_SESSIONS_DELETE
public static final ApiFunction _SESSIONS_DELETE
XQuery function.
-
_SESSIONS_GET
public static final ApiFunction _SESSIONS_GET
XQuery function.
-
_SESSIONS_IDS
public static final ApiFunction _SESSIONS_IDS
XQuery function.
-
_SESSIONS_NAMES
public static final ApiFunction _SESSIONS_NAMES
XQuery function.
-
_SESSIONS_SET
public static final ApiFunction _SESSIONS_SET
XQuery function.
-
_WS_BROADCAST
public static final ApiFunction _WS_BROADCAST
XQuery function.
-
_WS_CLOSE
public static final ApiFunction _WS_CLOSE
XQuery function.
-
_WS_DELETE
public static final ApiFunction _WS_DELETE
XQuery function.
-
_WS_EMIT
public static final ApiFunction _WS_EMIT
XQuery function.
-
_WS_EVAL
public static final ApiFunction _WS_EVAL
XQuery function.
-
_WS_GET
public static final ApiFunction _WS_GET
XQuery function.
-
_WS_ID
public static final ApiFunction _WS_ID
XQuery function.
-
_WS_IDS
public static final ApiFunction _WS_IDS
XQuery function.
-
_WS_PATH
public static final ApiFunction _WS_PATH
XQuery function.
-
_WS_SEND
public static final ApiFunction _WS_SEND
XQuery function.
-
_WS_SET
public static final ApiFunction _WS_SET
XQuery function.
-
-
Method Detail
-
values
public static ApiFunction[] 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 (ApiFunction c : ApiFunction.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ApiFunction 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 nameNullPointerException
- if the argument is null
-
definition
public FuncDefinition definition()
- Specified by:
definition
in interfaceAFunction
-
init
public static void init(ArrayList<FuncDefinition> list)
Adds function signatures to the list. Called via reflection during initialization.- Parameters:
list
- list of function signatures
-
toString
public final String toString()
- Overrides:
toString
in classEnum<ApiFunction>
-
-