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

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, 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 package org.opendaylight.yangtools.yang.model.api.stmt;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  12
  13 /**
  14  * Namespace of available {@code typedef}s inside of an {@link EffectiveStatement}. It holds that statement's
  15  * {@code typedef} substatements. This constitutes the statament's contribution to the following in accordance with
  16  * RFC7950 section 6.2.1:
  17  * <pre>
  18  *     All derived type names defined within a parent node or at the top
  19  *     level of the module or its submodules share the same type
  20  *     identifier namespace.  This namespace is scoped to all descendant
  21  *     nodes of the parent node or module.  This means that any
  22  *     descendant node may use that typedef, and it MUST NOT define a
  23  *     typedef with the same name.
  24  * </pre>
  25  *
  26  * @author Robert Varga
  27  */
  28 @Beta
  29 // FIXME: 7.0.0: add indexing of this namespace to yang-model-spi
  30 public abstract class TypedefNamespace extends EffectiveStatementNamespace<TypedefEffectiveStatement> {
  31     private TypedefNamespace() {
  32         // Should never be instantiated
  33     }
  34 }