opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Deviation.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.yang.model.api;\r
   9 \r
  10 import java.util.List;\r
  11 \r
  12 /**\r
  13  * Interface describing YANG 'deviation' statement.\r
  14  * <p>\r
  15  * The 'deviation' statement defines a hierarchy of a module that the device\r
  16  * does not implement faithfully. Deviations define the way a device deviate\r
  17  * from a standard.\r
  18  * </p>\r
  19  */\r
  20 public interface Deviation {\r
  21 \r
  22     /**\r
  23      * Enum describing YANG deviation 'deviate' statement. It defines how the\r
  24      * device's implementation of the target node deviates from its original\r
  25      * definition.\r
  26      */\r
  27     enum Deviate {\r
  28         NOT_SUPPORTED, ADD, REPLACE, DELETE\r
  29     }\r
  30 \r
  31     /**\r
  32      * @return SchemaPath that identifies the node in the schema tree where a\r
  33      *         deviation from the module occurs.\r
  34      */\r
  35     SchemaPath getTargetPath();\r
  36 \r
  37     /**\r
  38      * @return deviate statement of this deviation\r
  39      */\r
  40     Deviate getDeviate();\r
  41 \r
  42     /**\r
  43      * @return textual cross-reference to an external document that provides\r
  44      *         additional information relevant to this node.\r
  45      */\r
  46     String getReference();\r
  47 \r
  48     /**\r
  49      * @return collection of all unknown nodes defined under this schema node.\r
  50      */\r
  51     public List<UnknownSchemaNode> getUnknownSchemaNodes();\r
  52 \r
  53 }\r