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 /**\r
  11  * Interface describing YANG 'deviation' statement.\r
  12  * <p>\r
  13  * The 'deviation' statement defines a hierarchy of a module that the device\r
  14  * does not implement faithfully. Deviations define the way a device deviate\r
  15  * from a standard.\r
  16  * </p>\r
  17  */\r
  18 public interface Deviation {\r
  19 \r
  20     /**\r
  21      * Enum describing YANG deviation 'deviate' statement. It defines how the\r
  22      * device's implementation of the target node deviates from its original\r
  23      * definition.\r
  24      */\r
  25     enum Deviate {\r
  26         NOT_SUPPORTED, ADD, REPLACE, DELETE\r
  27     }\r
  28 \r
  29     /**\r
  30      * @return SchemaPath that identifies the node in the schema tree where a\r
  31      *         deviation from the module occurs.\r
  32      */\r
  33     SchemaPath getTargetPath();\r
  34 \r
  35     /**\r
  36      * @return deviate statement of this deviation\r
  37      */\r
  38     Deviate getDeviate();\r
  39 \r
  40     /**\r
  41      * @return textual cross-reference to an external document that provides\r
  42      *         additional information relevant to this node.\r
  43      */\r
  44     String getReference();\r
  45 \r
  46 }\r