Package org.basex.query.ann

Enum Class Annotation

java.lang.Object
java.lang.Enum<Annotation>
org.basex.query.ann.Annotation
All Implemented Interfaces:
Serializable, Comparable<Annotation>, java.lang.constant.Constable
public enum Annotation extends Enum<Annotation>
Definitions of all built-in XQuery annotations.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen

  • Enum Constant Details

    • PUBLIC

      public static final Annotation PUBLIC
      XQuery annotation.

    • PRIVATE

      public static final Annotation PRIVATE
      XQuery annotation.

    • UPDATING

      public static final Annotation UPDATING
      XQuery annotation.

    • _BASEX_LAZY

      public static final Annotation _BASEX_LAZY
      XQuery annotation.

    • _BASEX_INLINE

      public static final Annotation _BASEX_INLINE
      XQuery annotation.

    • _BASEX_LOCK

      public static final Annotation _BASEX_LOCK
      XQuery annotation.

    • _INPUT_CSV

      public static final Annotation _INPUT_CSV
      XQuery annotation.

    • _INPUT_HTML

      public static final Annotation _INPUT_HTML
      XQuery annotation.

    • _INPUT_JSON

      public static final Annotation _INPUT_JSON
      XQuery annotation.

    • _INPUT_TEXT

      public static final Annotation _INPUT_TEXT
      XQuery annotation.

    • _OUTPUT_ALLOW_DUPLICATE_NAMES

      public static final Annotation _OUTPUT_ALLOW_DUPLICATE_NAMES
      XQuery annotation.

    • _OUTPUT_BYTE_ORDER_MARK

      public static final Annotation _OUTPUT_BYTE_ORDER_MARK
      XQuery annotation.

    • _OUTPUT_CDATA_SECTION_ELEMENTS

      public static final Annotation _OUTPUT_CDATA_SECTION_ELEMENTS
      XQuery annotation.

    • _OUTPUT_CSV

      public static final Annotation _OUTPUT_CSV
      XQuery annotation.

    • _OUTPUT_DOCTYPE_PUBLIC

      public static final Annotation _OUTPUT_DOCTYPE_PUBLIC
      XQuery annotation.

    • _OUTPUT_DOCTYPE_SYSTEM

      public static final Annotation _OUTPUT_DOCTYPE_SYSTEM
      XQuery annotation.

    • _OUTPUT_ENCODING

      public static final Annotation _OUTPUT_ENCODING
      XQuery annotation.

    • _OUTPUT_ESCAPE_URI_ATTRIBUTES

      public static final Annotation _OUTPUT_ESCAPE_URI_ATTRIBUTES
      XQuery annotation.

    • _OUTPUT_HTML_VERSION

      public static final Annotation _OUTPUT_HTML_VERSION
      XQuery annotation.

    • _OUTPUT_INCLUDE_CONTENT_TYPE

      public static final Annotation _OUTPUT_INCLUDE_CONTENT_TYPE
      XQuery annotation.

    • _OUTPUT_INDENT

      public static final Annotation _OUTPUT_INDENT
      XQuery annotation.

    • _OUTPUT_INDENTS

      public static final Annotation _OUTPUT_INDENTS
      XQuery annotation.

    • _OUTPUT_ITEM_SEPARATOR

      public static final Annotation _OUTPUT_ITEM_SEPARATOR
      XQuery annotation.

    • _OUTPUT_JSON

      public static final Annotation _OUTPUT_JSON
      XQuery annotation.

    • _OUTPUT_JSON_NODE_OUTPUT_METHOD

      public static final Annotation _OUTPUT_JSON_NODE_OUTPUT_METHOD
      XQuery annotation.

    • _OUTPUT_MEDIA_TYPE

      public static final Annotation _OUTPUT_MEDIA_TYPE
      XQuery annotation.

    • _OUTPUT_METHOD

      public static final Annotation _OUTPUT_METHOD
      XQuery annotation.

    • _OUTPUT_NEWLINE

      public static final Annotation _OUTPUT_NEWLINE
      XQuery annotation.

    • _OUTPUT_NORMALIZATION_FORM

      public static final Annotation _OUTPUT_NORMALIZATION_FORM
      XQuery annotation.

    • _OUTPUT_OMIT_XML_DECLARATION

      public static final Annotation _OUTPUT_OMIT_XML_DECLARATION
      XQuery annotation.

    • _OUTPUT_PARAMETER_DOCUMENT

      public static final Annotation _OUTPUT_PARAMETER_DOCUMENT
      XQuery annotation.

    • _OUTPUT_STANDALONE

      public static final Annotation _OUTPUT_STANDALONE
      XQuery annotation.

    • _OUTPUT_SUPPRESS_INDENTATION

      public static final Annotation _OUTPUT_SUPPRESS_INDENTATION
      XQuery annotation.

    • _OUTPUT_TABULATOR

      public static final Annotation _OUTPUT_TABULATOR
      XQuery annotation.

    • _OUTPUT_UNDECLARE_PREFIXES

      public static final Annotation _OUTPUT_UNDECLARE_PREFIXES
      XQuery annotation.

    • _OUTPUT_USE_CHARACTER_MAPS

      public static final Annotation _OUTPUT_USE_CHARACTER_MAPS
      XQuery annotation.

    • _OUTPUT_VERSION

      public static final Annotation _OUTPUT_VERSION
      XQuery annotation.

    • _PERM_CHECK

      public static final Annotation _PERM_CHECK
      XQuery annotation.

    • _PERM_ALLOW

      public static final Annotation _PERM_ALLOW
      XQuery annotation.

    • _REST_PATH

      public static final Annotation _REST_PATH
      XQuery annotation.

    • _REST_ERROR

      public static final Annotation _REST_ERROR
      XQuery annotation.

    • _REST_CONSUMES

      public static final Annotation _REST_CONSUMES
      XQuery annotation.

    • _REST_PRODUCES

      public static final Annotation _REST_PRODUCES
      XQuery annotation.

    • _REST_QUERY_PARAM

      public static final Annotation _REST_QUERY_PARAM
      XQuery annotation.

    • _REST_FORM_PARAM

      public static final Annotation _REST_FORM_PARAM
      XQuery annotation.

    • _REST_HEADER_PARAM

      public static final Annotation _REST_HEADER_PARAM
      XQuery annotation.

    • _REST_COOKIE_PARAM

      public static final Annotation _REST_COOKIE_PARAM
      XQuery annotation.

    • _REST_ERROR_PARAM

      public static final Annotation _REST_ERROR_PARAM
      XQuery annotation.

    • _REST_METHOD

      public static final Annotation _REST_METHOD
      XQuery annotation.

    • _REST_SINGLE

      public static final Annotation _REST_SINGLE
      XQuery annotation.

    • _REST_GET

      public static final Annotation _REST_GET
      XQuery annotation.

    • _REST_POST

      public static final Annotation _REST_POST
      XQuery annotation.

    • _REST_PUT

      public static final Annotation _REST_PUT
      XQuery annotation.

    • _REST_DELETE

      public static final Annotation _REST_DELETE
      XQuery annotation.

    • _REST_HEAD

      public static final Annotation _REST_HEAD
      XQuery annotation.

    • _REST_OPTIONS

      public static final Annotation _REST_OPTIONS
      XQuery annotation.

    • _UNIT_AFTER

      public static final Annotation _UNIT_AFTER
      XQuery annotation.

    • _UNIT_AFTER_MODULE

      public static final Annotation _UNIT_AFTER_MODULE
      XQuery annotation.

    • _UNIT_BEFORE

      public static final Annotation _UNIT_BEFORE
      XQuery annotation.

    • _UNIT_BEFORE_MODULE

      public static final Annotation _UNIT_BEFORE_MODULE
      XQuery annotation.

    • _UNIT_IGNORE

      public static final Annotation _UNIT_IGNORE
      XQuery annotation.

    • _UNIT_TEST

      public static final Annotation _UNIT_TEST
      XQuery annotation.

    • _WS_CONNECT

      public static final Annotation _WS_CONNECT
      XQuery annotation.

    • _WS_MESSAGE

      public static final Annotation _WS_MESSAGE
      XQuery annotation.

    • _WS_CLOSE

      public static final Annotation _WS_CLOSE
      XQuery annotation.

    • _WS_HEADER_PARAM

      public static final Annotation _WS_HEADER_PARAM
      XQuery annotation.

    • _WS_ERROR

      public static final Annotation _WS_ERROR
      XQuery annotation.

  • Field Details

    • args

      public final SeqType[] args
      Argument types.

    • uri

      public final byte[] uri
      URI.

    • minMax

      public final int[] minMax
      Minimum and maximum number of arguments.

    • single

      public final boolean single
      Annotation must only occur once.

    • VALUES

      public static final Annotation[] VALUES
      Cached enums (faster).

  • Method Details

    • values

      public static Annotation[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Annotation valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • get

      public static Annotation get(QNm name)
      Returns an annotation with the specified name.
      Parameters:
      name - name
      Returns:
      annotation or null

    • local

      public byte[] local()
      Returns the local name of the annotation.
      Returns:
      name

    • qname

      public QNm qname()
      Returns the QName of the annotation.
      Returns:
      QName

    • id

      public byte[] id()
      Returns the prefixed name of the annotation.
      Returns:
      name

    • toString

      public String toString()
      Overrides:
      toString in class Enum<Annotation>