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  *
  15  * <p>
  16  * The 'deviation' statement defines a hierarchy of a module that the device does not implement faithfully. Deviations
  17  * define the way a device deviate from a standard.
  18  */
  19 public interface Deviation extends DocumentedNode {
  20
  21     /**
  22      * Returns target schema path.
  23      *
  24      * @return SchemaPath that identifies the node in the schema tree where a deviation from the module occurs.
  25      */
  26     SchemaPath getTargetPath();
  27
  28     /**
  29      * Returns deviate children.
  30      *
  31      * @return List of all deviate statements defined in this deviation.
  32      */
  33     List<DeviateDefinition> getDeviates();
  34 }