Package org.basex.query.func.inspect

Class Inspect

java.lang.Object
org.basex.query.func.inspect.Inspect
public abstract class Inspect extends Object
Abstract inspector class.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final byte[]
    DOC_DESCRIPTION
    Documentation: description tag.
    static final byte[]
    DOC_PARAM
    Documentation: param tag.
    static final byte[]
    DOC_RETURN
    Documentation: return tag.
    static final byte[][]
    DOC_TAGS
    Supported documentation tags.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    add(byte[] value, FElem elem)
    Parses a string as XML and adds the resulting nodes to the specified parent.
    static byte[]
    doc(TokenObjMap<TokenList> doc, byte[] name)
    Returns a value for the specified parameter or null.
    protected abstract FElem
    elem(byte[] name, FElem parent)
    Creates a new element.
    protected abstract FElem
    elem(String name, FElem parent)
    Creates an element.
    abstract FElem
    parse(IO io)
    Parses a module and returns an inspection element.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DOC_TAGS

      public static final byte[][] DOC_TAGS
      Supported documentation tags.

    • DOC_DESCRIPTION

      public static final byte[] DOC_DESCRIPTION
      Documentation: description tag.

    • DOC_PARAM

      public static final byte[] DOC_PARAM
      Documentation: param tag.

    • DOC_RETURN

      public static final byte[] DOC_RETURN
      Documentation: return tag.

  • Method Details

    • parse

      public abstract FElem parse(IO io) throws QueryException
      Parses a module and returns an inspection element.
      Parameters:
      io - input reference
      Returns:
      inspection element
      Throws:
      QueryException - query exception

    • elem

      protected abstract FElem elem(byte[] name, FElem parent)
      Creates a new element.
      Parameters:
      name - element name
      parent - parent element
      Returns:
      element

    • elem

      protected abstract FElem elem(String name, FElem parent)
      Creates an element.
      Parameters:
      name - name of element
      parent - parent element
      Returns:
      element node

    • add

      public static void add(byte[] value, FElem elem)
      Parses a string as XML and adds the resulting nodes to the specified parent.
      Parameters:
      value - string to parse
      elem - element

    • doc

      public static byte[] doc(TokenObjMap<TokenList> doc, byte[] name)
      Returns a value for the specified parameter or null.
      Parameters:
      doc - documentation
      name - parameter name
      Returns:
      documentation of specified variable or null