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 {
  21
  22     /**
  23      * @return SchemaPath that identifies the node in the schema tree where a
  24      *         deviation from the module occurs.
  25      */
  26     SchemaPath getTargetPath();
  27
  28     /**
  29      *
  30      * @return List of all deviate statements defined in this deviation
  31      */
  32     List<DeviateDefinition> getDeviates();
  33
  34     /**
  35      *
  36      * @return textual description of this deviation
  37      */
  38     String getDescription();
  39
  40     /**
  41      * @return textual cross-reference to an external document that provides
  42      *         additional information relevant to this node.
  43      */
  44     String getReference();
  45
  46     /**
  47      * @return collection of all unknown nodes defined under this schema node.
  48      */
  49     List<UnknownSchemaNode> getUnknownSchemaNodes();
  50
  51 }