Deprecate preliminary XPath/NormalizedNode interfaces

[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / schema / xpath / XPathSchemaContext.java

diff --git a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java
index 335a5ed529ab2653ff27080e675c27566728f4cf..f0e1b5adf5adf80f3b9911d5f531876977a51848 100644 (file)
--- a/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java
+++ b/yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/xpath/XPathSchemaContext.java
@@ -8,8 +8,10 @@
 package org.opendaylight.yangtools.yang.data.api.schema.xpath;
 
 import com.google.common.annotations.Beta;
-import javax.annotation.Nonnull;
+import com.google.common.base.Converter;
 import javax.xml.xpath.XPathExpressionException;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 
@@ -18,18 +20,24 @@ import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  * a particular root node.
  */
 @Beta
+@Deprecated
 public interface XPathSchemaContext {
     /**
      * Compile an XPath expression for execution on {@link XPathDocument}s produced by this context.
      *
-     * @param xpath XPath expression to compile
+     * <p>
+     * The user must provide a prefix-to-mapping {@link Converter}, which will be used to convert any prefixes found
+     * in the XPath expression being compiled in the resulting context.
+     *
      * @param schemaPath Schema path of the node at which this expression is expected to be evaluated
+     * @param prefixes Prefix-to-namespace converter
+     * @param xpath XPath expression to compile
      * @return A compiled XPath expression
      * @throws XPathExpressionException if the provided expression is invalid, either syntactically or by referencing
      *         namespaces unknown to this schema context.
      */
-    @Nonnull XPathExpression compileExpression(@Nonnull String xpath, @Nonnull SchemaPath schemaPath)
-            throws XPathExpressionException;
+    @NonNull XPathExpression compileExpression(@NonNull SchemaPath schemaPath,
+            @NonNull Converter<String, QNameModule> prefixes, @NonNull String xpath) throws XPathExpressionException;
 
     /**
      * Create a new document context.
@@ -38,5 +46,5 @@ public interface XPathSchemaContext {
      * @return A new {@link XPathDocument} on which queries may be executed.
      * @throws IllegalArgumentException if the document root is not known to this schema context.
      */
-    @Nonnull XPathDocument createDocument(@Nonnull NormalizedNode<?, ?> documentRoot);
+    @NonNull XPathDocument createDocument(@NonNull NormalizedNode<?, ?> documentRoot);
 }