yang/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/TypeNamespace.java

   1 /*
   2  * Copyright (c) 2015 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.parser.spi;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  13 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  14 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  15 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace.TreeScoped;
  16 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  17
  18 /**
  19  * Derived types namespace. All derived type names defined within a parent node or at the top level of the module
  20  * (or its submodules) share the same type identifier namespace.
  21  *
  22  * <p>
  23  * This namespace is scoped to all descendant nodes of the parent node or module. This means that any descendant node
  24  * may use that typedef, and it MUST NOT define a typedef with the same name.
  25  *
  26  * <p>
  27  * This namespace includes all type definitions implied by the language in which the current statement resides
  28  * (e.g. RFC6020/RFC7950 for YANG 1.0/1.1).
  29  */
  30 public interface TypeNamespace extends TreeScoped<QName, TypedefStatement, TypedefEffectiveStatement> {
  31     NamespaceBehaviour<QName, StmtContext<?, TypedefStatement, TypedefEffectiveStatement>, @NonNull TypeNamespace>
  32         BEHAVIOUR = NamespaceBehaviour.treeScoped(TypeNamespace.class);
  33
  34 }