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-21, BSD License, Christian Gruen

  • Field Details

    • Q_SPARAM

      public static final QNm Q_SPARAM
      QName.

  • Constructor Details

    • FuncOptions

      public FuncOptions(InputInfo info)
      Constructor.
      Parameters:
      info - input info

    • FuncOptions

      public FuncOptions(QNm root, InputInfo info)
      Constructor.
      Parameters:
      root - name of root node (can be null)
      info - input info

  • Method Details

    • acceptUnknown

      public FuncOptions acceptUnknown()
      Accept unknown options.
      Returns:
      self reference

    • 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 ii) throws QueryException
      Converts the specified output parameter item to serialization parameters.
      Parameters:
      item - input item
      ii - input info
      Returns:
      serialization parameters
      Throws:
      QueryException - query exception

    • serializer

      public static SerializerOptions serializer(Item item, SerializerOptions sopts, InputInfo ii) throws QueryException
      Converts the specified output parameter item to serializer options.
      Parameters:
      item - input item
      sopts - serialization parameters
      ii - input info
      Returns:
      serialization parameters
      Throws:
      QueryException - query exception