yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/IdentityStatementSupport.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 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.Status;
  23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.BaseEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.IdentityEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.IdentityStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  32 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  33 import org.opendaylight.yangtools.yang.parser.spi.IdentityNamespace;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  41
  42 @Beta
  43 public final class IdentityStatementSupport
  44         extends AbstractQNameStatementSupport<IdentityStatement, IdentityEffectiveStatement> {
  45     private static final @NonNull IdentityStatementSupport RFC6020_INSTANCE = new IdentityStatementSupport(
  46         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  47             .addOptional(YangStmtMapping.BASE)
  48             .addOptional(YangStmtMapping.DESCRIPTION)
  49             .addOptional(YangStmtMapping.REFERENCE)
  50             .addOptional(YangStmtMapping.STATUS)
  51             .build());
  52     private static final @NonNull IdentityStatementSupport RFC7950_INSTANCE = new IdentityStatementSupport(
  53         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  54             .addAny(YangStmtMapping.BASE)
  55             .addOptional(YangStmtMapping.DESCRIPTION)
  56             .addAny(YangStmtMapping.IF_FEATURE)
  57             .addOptional(YangStmtMapping.REFERENCE)
  58             .addOptional(YangStmtMapping.STATUS)
  59             .build());
  60
  61     private final SubstatementValidator validator;
  62
  63     private IdentityStatementSupport(final SubstatementValidator validator) {
  64         super(YangStmtMapping.IDENTITY, StatementPolicy.reject());
  65         this.validator = requireNonNull(validator);
  66     }
  67
  68     public static @NonNull IdentityStatementSupport rfc6020Instance() {
  69         return RFC6020_INSTANCE;
  70     }
  71
  72     public static @NonNull IdentityStatementSupport rfc7950Instance() {
  73         return RFC7950_INSTANCE;
  74     }
  75
  76     @Override
  77     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  78         return StmtContextUtils.parseIdentifier(ctx, value);
  79     }
  80
  81     @Override
  82     public void onStatementDefinitionDeclared(
  83             final Mutable<QName, IdentityStatement, IdentityEffectiveStatement> stmt) {
  84         final QName qname = stmt.getArgument();
  85         final StmtContext<?, ?, ?> prev = stmt.getFromNamespace(IdentityNamespace.class, qname);
  86         SourceException.throwIf(prev != null, stmt, "Duplicate identity definition %s", qname);
  87         stmt.addToNs(IdentityNamespace.class, qname, stmt);
  88     }
  89
  90     @Override
  91     protected SubstatementValidator getSubstatementValidator() {
  92         return validator;
  93     }
  94
  95     @Override
  96     protected IdentityStatement createDeclared(final StmtContext<QName, IdentityStatement, ?> ctx,
  97             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  98         return DeclaredStatements.createIdentity(ctx.getArgument(), substatements);
  99     }
 100
 101     @Override
 102     protected IdentityEffectiveStatement createEffective(final Current<QName, IdentityStatement> stmt,
 103             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 104         if (substatements.isEmpty()) {
 105             return EffectiveStatements.createIdentity(stmt.declared(), stmt.effectivePath());
 106         }
 107
 108         final List<IdentitySchemaNode> identities = new ArrayList<>();
 109         for (EffectiveStatement<?, ?> substatement : substatements) {
 110             if (substatement instanceof BaseEffectiveStatement) {
 111                 final QName qname = ((BaseEffectiveStatement) substatement).argument();
 112                 final IdentityEffectiveStatement identity =
 113                         verifyNotNull(stmt.getFromNamespace(IdentityNamespace.class, qname),
 114                             "Failed to find identity %s", qname)
 115                         .buildEffective();
 116                 verify(identity instanceof IdentitySchemaNode, "%s is not a IdentitySchemaNode", identity);
 117                 identities.add((IdentitySchemaNode) identity);
 118             }
 119         }
 120
 121         return EffectiveStatements.createIdentity(stmt.declared(), stmt.effectivePath(), new FlagsBuilder()
 122             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 123             .toFlags(), substatements, ImmutableSet.copyOf(identities));
 124     }
 125 }