yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/package-info.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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 /**
   9  * Statement library for YANG version 1 and 1.1, as defined in RFC6020 and RFC7950. Since YANG 1.1 is built on top
  10  * of YANG 1 and our semantic model follows version 1.1, base statements are organized in a single package hierarchy.
  11  *
  12  * <p>
  13  * Each statement has its own package underneath this package, from which it exports the StatementSupport instance,
  14  * which can be wired into the statement reactor. Other classes should be kept package-private, so inter-statement
  15  * interactions follow properly-exposed API interfaces.
  16  *
  17  * <p>
  18  * Common base and utility classes for individual statement implementations are maintained in this package. This package
  19  * is not meant for consumption by end users and should be used only by parser extensions.
  20  *
  21  * <p>
  22  * Do not use bare implementation classes exposed from statement sub-packages, as their details are explicitly outside
  23  * of API contract. The only exception to this rule are the StatementSupport classes, which allow for correlation and
  24  * creation of known YANG statements.
  25  *
  26  * @author Robert Varga
  27  */
  28 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;