Package org.basex.query.func

Class FuncOptions

java.lang.Object

org.basex.query.func.FuncOptions

public final class FuncOptions
extends Object

This class parses options specified in function arguments.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
static QNm	Q_SERIALIZTION_PARAMETERS	QName.

Constructor Summary

Constructors

Constructor	Description
FuncOptions(QNm root, InputInfo info)	Constructor.
FuncOptions(InputInfo info)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T extends Options> T	assign(Item item, T options)	Assigns values to the specified options.
static SerializerOptions	serializer(Item item, SerializerOptions sopts, InputInfo info)	Converts the specified output parameter item to serializer options.
static SerializerOptions	serializer(Item item, InputInfo info)	Converts the specified output parameter item to serialization parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Q_SERIALIZTION_PARAMETERS

public static final QNm Q_SERIALIZTION_PARAMETERS

QName.

Constructor Detail

FuncOptions

public FuncOptions(InputInfo info)

Constructor.

Parameters:

info - input info (can be null)

FuncOptions

public FuncOptions(QNm root,
                   InputInfo info)

Constructor.

Parameters:

root - name of root node (can be null)

info - input info (can be null)

Method Detail

assign

public <T extends Options> T assign(Item item,
                                    T options)
                             throws QueryException

Assigns values to the specified options.

Type Parameters:

T - option type

Parameters:

item - item to be converted (can be Empty.VALUE)

options - options

Returns:

specified options

Throws:

QueryException - query exception

serializer

public static SerializerOptions serializer(Item item,
                                           InputInfo info)
                                    throws QueryException

Converts the specified output parameter item to serialization parameters.

Parameters:

item - input item

info - input info (can be null)

Returns:

serialization parameters

Throws:

QueryException - query exception

serializer

public static SerializerOptions serializer(Item item,
                                           SerializerOptions sopts,
                                           InputInfo info)
                                    throws QueryException

Converts the specified output parameter item to serializer options.

Parameters:

item - input item

sopts - serialization parameters

info - input info (can be null)

Returns:

serialization parameters

Throws:

QueryException - query exception