org.opendaylight.yangtools.yang.xpath.api

Interface YangXPathParserFactory

All Known Implementing Classes:

AntlrXPathParserFactory

@Beta
public interface YangXPathParserFactory

Factory for creating YangXPathParsers. Implementations of this interface are expected to be thread-safe.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
default YangXPathParser	newParser() Return a YangXPathParser compliant with YangXPathMathMode.IEEE754.
default YangXPathParser.QualifiedBound	newParser(YangNamespaceContext namespaceContext) Return a YangXPathParser compliant with YangXPathMathMode.IEEE754.
default YangXPathParser.UnqualifiedBound	newParser(YangNamespaceContext namespaceContext, QNameModule defaultNamespace) Return a YangXPathParser compliant with YangXPathMathMode.IEEE754.
YangXPathParser	newParser(YangXPathMathMode mathMode) Return a YangXPathParser compliant with YangXPathMathMode.
YangXPathParser.QualifiedBound	newParser(YangXPathMathMode mathMode, YangNamespaceContext namespaceContext) Return a YangXPathParser compliant with YangXPathMathMode.
YangXPathParser.UnqualifiedBound	newParser(YangXPathMathMode mathMode, YangNamespaceContext namespaceContext, QNameModule defaultNamespace) Return a YangXPathParser compliant with YangXPathMathMode.

Method Detail

newParser

default YangXPathParser newParser()

Return a YangXPathParser compliant with YangXPathMathMode.IEEE754. Returned parser will not perform any namespace binding.

Returns:

An XPathParser

newParser

YangXPathParser newParser(YangXPathMathMode mathMode)

Return a YangXPathParser compliant with YangXPathMathMode. Returned parser will not perform any namespace binding.

Parameters:

mathMode - Requested XPath number compliance

Returns:

An XPathParser

Throws:

NullPointerException - if mathMode is null

newParser

default YangXPathParser.QualifiedBound newParser(YangNamespaceContext namespaceContext)

Return a YangXPathParser compliant with YangXPathMathMode.IEEE754. Returned parser will bind qualified node identifiers to QNames.

Parameters:

namespaceContext - Prefix-to-namespace resolver, used to bind qualified node identifiers

Returns:

An XPathParser

Throws:

NullPointerException - if namespaceContext is null

newParser

YangXPathParser.QualifiedBound newParser(YangXPathMathMode mathMode,
                                         YangNamespaceContext namespaceContext)

Return a YangXPathParser compliant with YangXPathMathMode. Returned parser will bind qualified node identifiers to QNames.

Parameters:

mathMode - Requested XPath number compliance

namespaceContext - Prefix-to-namespace resolver, used to bind qualified node identifiers

Returns:

An XPathParser

Throws:

NullPointerException - if any argument is null

newParser

default YangXPathParser.UnqualifiedBound newParser(YangNamespaceContext namespaceContext,
                                                   QNameModule defaultNamespace)

Return a YangXPathParser compliant with YangXPathMathMode.IEEE754. Returned parser will bind qualified and unqualified node identifiers to QNames.

Parameters:

namespaceContext - Prefix-to-namespace resolver, used to bind qualified node identifiers

defaultNamespace - Default namespace, used to bind unqualified node identifiers

Returns:

An XPathParser

Throws:

NullPointerException - if any argument is null

newParser

YangXPathParser.UnqualifiedBound newParser(YangXPathMathMode mathMode,
                                           YangNamespaceContext namespaceContext,
                                           QNameModule defaultNamespace)

Return a YangXPathParser compliant with YangXPathMathMode. Returned parser will bind qualified and unqualified node identifiers to QNames.

Parameters:

mathMode - Requested XPath number compliance

namespaceContext - Prefix-to-namespace resolver, used to bind qualified node identifiers

defaultNamespace - Default namespace, used to bind unqualified node identifiers

Returns:

An XPathParser

Throws:

NullPointerException - if any argument is null