Comments added to a source codes.

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / MustDefinition.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java
index c6b9b223868196775290357fd6b2c7bd93d40ff4..c725d3c546742ddd69a8c81a50a1374774b75ee9 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/MustDefinition.java
@@ -1,13 +1,28 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.yang.model.api;\r
-\r
-public interface MustDefinition extends ConstraintMetaDefinition {\r
-\r
-    RevisionAwareXPath getXpath();\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.model.api;
+
+/**
+ * 
+ * Contains methods for accessing constraint declaration for valid data in form
+ * of XPath expressions.<br />
+ * <br />
+ * <i>YANG example:<br />
+ * <code>must "ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)";</code>
+ * </i>
+ */
+public interface MustDefinition extends ConstraintMetaDefinition {
+
+    /**
+     * Returns XPath expression which contains constraint.
+     * 
+     * @return XPath expression which represents the value of the argument of
+     *         the <code>must</code> YANG substatement
+     */
+    RevisionAwareXPath getXpath();
+}