Update yang-xpath-api design

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

diff --git a/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathParser.java b/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathParser.java
index f0e594909a36e5f96390068da33edfe6ba31b378..0545366427621528de12990052ffe3252b425997 100644 (file)
--- a/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathParser.java
+++ b/yang/yang-xpath-api/src/main/java/org/opendaylight/yangtools/yang/xpath/api/YangXPathParser.java
@@ -11,9 +11,21 @@ import com.google.common.annotations.Beta;
 import javax.annotation.concurrent.NotThreadSafe;
 import javax.xml.xpath.XPathExpressionException;
 
+/**
+ * Interface for converting a String into a {@link YangXPathExpression}.
+ *
+ * @author Robert Varga
+ */
 @Beta
 @NotThreadSafe
 public interface YangXPathParser {
-
+    /**
+     * Parse a string containing an XPath expression.
+     *
+     * @param xpath XPath expression string
+     * @return A parsed {@link YangXPathExpression}
+     * @throws NullPointerException if {@code xpath} is null
+     * @throws XPathExpressionException when the expression cannot be parsed
+     */
     YangXPathExpression parseExpression(String xpath) throws XPathExpressionException;
 }