Update yang-xpath-api design

[yangtools.git] / yang / yang-xpath-api / src / main / java / org / opendaylight / yangtools / yang / xpath / api / YangXPathExpression.java

diff --git a/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathExpression.java b/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathExpression.java
index 91d3e7c37df91a8a6fdd7e6472abf3bec24473ea..da7ac0068fa3037ba012850e25f28ccfd2b487ca 100644 (file)
--- a/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathExpression.java
+++ b/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathExpression.java
@@ -12,11 +12,28 @@ import javax.xml.xpath.XPathExpressionException;
 import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.yang.common.QName;
 
+/**
+ * An XPath expression.
+ *
+ * @author Robert Varga
+ */
 @Beta
 public interface YangXPathExpression extends Immutable {
-
+    /**
+     * Return the root {@link YangExpr}.
+     *
+     * @return Root expression.
+     */
     YangExpr getRootExpr();
 
+    /**
+     * Return the {@link YangXPathMathMode} used in this expression. All {@link YangNumberExpr} objects used by this
+     * expression are expected to be handled by this mode's {@link YangXPathMathSupport}.
+     *
+     * @return YangXPathMathMode
+     */
+    YangXPathMathMode getMathMode();
+
     /**
      * Attempt to interpret a {@link YangLiteralExpr} referenced by this expression as a {@link QName}. This method
      * is required to perform late value binding of the expression when the literal needs to be interpreted as
@@ -32,12 +49,12 @@ public interface YangXPathExpression extends Immutable {
      * at evaluation.
      *
      * @param expr Literal to be reinterpreted
-     * @return QName representation of the literal
+     * @return YangQNameExpr result of interpretation
      * @throws XPathExpressionException when the literal cannot be interpreted as a QName
      */
-    QName interpretAsQName(YangLiteralExpr expr) throws XPathExpressionException;
+    YangQNameExpr interpretAsQName(YangLiteralExpr expr) throws XPathExpressionException;
 
-    // API design: this really should be YangInstanceIdentifier without AugmentationIdentifier. Implementations are
-    //             strongly encouraged to validate it as such.
+    // FIXME: this really should be YangInstanceIdentifier without AugmentationIdentifier. Implementations are
+    //        strongly encouraged to validate it as such.
     YangLocationPath interpretAsInstanceIdentifier(YangLiteralExpr expr) throws XPathExpressionException;
 }