Cleanup checkstyle in yang-{data,model}-api
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / Deviation.java
index 3a7cce85b546545f1c5f49b915a178e88cbb0991..e3d3663f1e115a4da887a81a1817448793f816e0 100644 (file)
@@ -11,41 +11,47 @@ import java.util.List;
 
 /**
  * Interface describing YANG 'deviation' statement.
+ *
  * <p>
  * The 'deviation' statement defines a hierarchy of a module that the device
  * does not implement faithfully. Deviations define the way a device deviate
  * from a standard.
- * </p>
  */
 public interface Deviation {
 
     /**
-     * Enum describing YANG deviation 'deviate' statement. It defines how the
-     * device's implementation of the target node deviates from its original
-     * definition.
-     */
-    enum Deviate {
-        NOT_SUPPORTED, ADD, REPLACE, DELETE
-    }
-
-    /**
+     * Returns target schema path.
+     *
      * @return SchemaPath that identifies the node in the schema tree where a
      *         deviation from the module occurs.
      */
     SchemaPath getTargetPath();
 
     /**
-     * @return deviate statement of this deviation
+     * Returns deviate children.
+     *
+     * @return List of all deviate statements defined in this deviation
+     */
+    List<DeviateDefinition> getDeviates();
+
+    /**
+     * Returns the description text.
+     *
+     * @return textual description of this deviation
      */
-    Deviate getDeviate();
+    String getDescription();
 
     /**
+     * Returns reference.
+     *
      * @return textual cross-reference to an external document that provides
      *         additional information relevant to this node.
      */
     String getReference();
 
     /**
+     * Returns unknown schema node children.
+     *
      * @return collection of all unknown nodes defined under this schema node.
      */
     List<UnknownSchemaNode> getUnknownSchemaNodes();