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