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