yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/SubmoduleStatementImpl.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.stmt.rfc6020;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  12
  13 import java.util.Optional;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.yangtools.yang.common.Revision;
  16 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionStatement;
  23 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  24 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  25 import org.opendaylight.yangtools.yang.model.util.ModuleIdentifierImpl;
  26 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  34 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.SubmoduleEffectiveStatementImpl;
  35
  36 public class SubmoduleStatementImpl extends AbstractRootStatement<SubmoduleStatement> implements SubmoduleStatement {
  37     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  38             .SUBMODULE)
  39             .addAny(YangStmtMapping.ANYXML)
  40             .addAny(YangStmtMapping.AUGMENT)
  41             .addMandatory(YangStmtMapping.BELONGS_TO)
  42             .addAny(YangStmtMapping.CHOICE)
  43             .addOptional(YangStmtMapping.CONTACT)
  44             .addAny(YangStmtMapping.CONTAINER)
  45             .addOptional(YangStmtMapping.DESCRIPTION)
  46             .addAny(YangStmtMapping.DEVIATION)
  47             .addAny(YangStmtMapping.EXTENSION)
  48             .addAny(YangStmtMapping.FEATURE)
  49             .addAny(YangStmtMapping.GROUPING)
  50             .addAny(YangStmtMapping.IDENTITY)
  51             .addAny(YangStmtMapping.IMPORT)
  52             .addAny(YangStmtMapping.INCLUDE)
  53             .addAny(YangStmtMapping.LEAF)
  54             .addAny(YangStmtMapping.LEAF_LIST)
  55             .addAny(YangStmtMapping.LIST)
  56             .addAny(YangStmtMapping.NOTIFICATION)
  57             .addOptional(YangStmtMapping.ORGANIZATION)
  58             .addOptional(YangStmtMapping.REFERENCE)
  59             .addAny(YangStmtMapping.REVISION)
  60             .addAny(YangStmtMapping.RPC)
  61             .addAny(YangStmtMapping.TYPEDEF)
  62             .addAny(YangStmtMapping.USES)
  63             .addOptional(YangStmtMapping.YANG_VERSION)
  64             .build();
  65
  66     protected SubmoduleStatementImpl(final StmtContext<String, SubmoduleStatement, ?> context) {
  67         super(context);
  68     }
  69
  70     public static class Definition extends AbstractStatementSupport<String, SubmoduleStatement,
  71             EffectiveStatement<String, SubmoduleStatement>> {
  72
  73         public Definition() {
  74             super(YangStmtMapping.SUBMODULE);
  75         }
  76
  77         @Override
  78         public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  79             return value;
  80         }
  81
  82         @Override
  83         public SubmoduleStatement createDeclared(
  84                 final StmtContext<String, SubmoduleStatement, ?> ctx) {
  85             return new SubmoduleStatementImpl(ctx);
  86         }
  87
  88         @Override
  89         public EffectiveStatement<String, SubmoduleStatement> createEffective(
  90                 final StmtContext<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> ctx) {
  91             return new SubmoduleEffectiveStatementImpl(ctx);
  92         }
  93
  94         @Override
  95         public void onPreLinkageDeclared(
  96                 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
  97             stmt.setRootIdentifier(RevisionSourceIdentifier.create(stmt.getStatementArgument(),
  98                 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements())));
  99         }
 100
 101         @Override
 102         public void onLinkageDeclared(
 103                 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
 104             final SourceIdentifier submoduleIdentifier = RevisionSourceIdentifier.create(stmt.getStatementArgument(),
 105                 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()));
 106
 107             final StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>
 108                 possibleDuplicateSubmodule = stmt.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
 109             if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
 110                 throw new SourceException(stmt.getStatementSourceReference(), "Submodule name collision: %s. At %s",
 111                         stmt.getStatementArgument(), possibleDuplicateSubmodule.getStatementSourceReference());
 112             }
 113
 114             stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
 115
 116             final String belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(), BelongsToStatement.class);
 117             final StmtContext<?, ?, ?> prefixSubStmtCtx = findFirstDeclaredSubstatement(stmt, 0,
 118                     BelongsToStatement.class, PrefixStatement.class);
 119             SourceException.throwIfNull(prefixSubStmtCtx, stmt.getStatementSourceReference(),
 120                     "Prefix of belongsTo statement is missing in submodule [%s]", stmt.getStatementArgument());
 121
 122             final String prefix = (String) prefixSubStmtCtx.getStatementArgument();
 123
 124             stmt.addToNs(BelongsToPrefixToModuleName.class, prefix, belongsToModuleName);
 125         }
 126
 127         private static ModuleIdentifier getSubmoduleIdentifier(
 128                 final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> stmt) {
 129             final Optional<Revision> maybeDate = StmtContextUtils.getLatestRevision(stmt.declaredSubstatements());
 130             return ModuleIdentifierImpl.create(stmt.getStatementArgument(), maybeDate);
 131         }
 132
 133         @Override
 134         protected SubstatementValidator getSubstatementValidator() {
 135             return SUBSTATEMENT_VALIDATOR;
 136         }
 137     }
 138
 139     @Nonnull
 140     @Override
 141     public String getName() {
 142         return rawArgument();
 143     }
 144
 145     @Override
 146     public YangVersionStatement getYangVersion() {
 147         return firstDeclared(YangVersionStatement.class);
 148     }
 149
 150     @Nonnull
 151     @Override
 152     public BelongsToStatement getBelongsTo() {
 153         return firstDeclared(BelongsToStatement.class);
 154     }
 155 }