yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Deviation.java

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