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
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableSet;
  16 import java.util.ArrayList;
  17 import java.util.List;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.Status;
  22 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  23 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  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.DeclaredStatementDecorators;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  32 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  33 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  34 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  35 import org.opendaylight.yangtools.yang.parser.spi.IdentityNamespace;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  42 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  43
  44 @Beta
  45 public final class IdentityStatementSupport
  46         extends AbstractQNameStatementSupport<IdentityStatement, IdentityEffectiveStatement> {
  47     private static final SubstatementValidator RFC6020_VALIDATOR =
  48         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  49             .addOptional(YangStmtMapping.BASE)
  50             .addOptional(YangStmtMapping.DESCRIPTION)
  51             .addOptional(YangStmtMapping.REFERENCE)
  52             .addOptional(YangStmtMapping.STATUS)
  53             .build();
  54     private static final SubstatementValidator RFC7950_VALIDATOR =
  55         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  56             .addAny(YangStmtMapping.BASE)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addAny(YangStmtMapping.IF_FEATURE)
  59             .addOptional(YangStmtMapping.REFERENCE)
  60             .addOptional(YangStmtMapping.STATUS)
  61             .build();
  62
  63     private IdentityStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  64         super(YangStmtMapping.IDENTITY, StatementPolicy.reject(), config, validator);
  65     }
  66
  67     public static @NonNull IdentityStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  68         return new IdentityStatementSupport(config, RFC6020_VALIDATOR);
  69     }
  70
  71     public static @NonNull IdentityStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  72         return new IdentityStatementSupport(config, RFC7950_VALIDATOR);
  73     }
  74
  75     @Override
  76     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  77         return StmtContextUtils.parseIdentifier(ctx, value);
  78     }
  79
  80     @Override
  81     public void onStatementDefinitionDeclared(
  82             final Mutable<QName, IdentityStatement, IdentityEffectiveStatement> stmt) {
  83         final QName qname = stmt.getArgument();
  84         final StmtContext<?, ?, ?> prev = stmt.getFromNamespace(IdentityNamespace.class, qname);
  85         SourceException.throwIf(prev != null, stmt, "Duplicate identity definition %s", qname);
  86         stmt.addToNs(IdentityNamespace.class, qname, stmt);
  87     }
  88
  89     @Override
  90     protected IdentityStatement createDeclared(final StmtContext<QName, IdentityStatement, ?> ctx,
  91             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  92         return DeclaredStatements.createIdentity(ctx.getArgument(), substatements);
  93     }
  94
  95     @Override
  96     protected IdentityStatement attachDeclarationReference(final IdentityStatement stmt,
  97             final DeclarationReference reference) {
  98         return DeclaredStatementDecorators.decorateIdentity(stmt, reference);
  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 }