yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/identity/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.identity;
   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.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  32 import org.opendaylight.yangtools.yang.parser.spi.IdentityNamespace;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  40
  41 @Beta
  42 public final class IdentityStatementSupport
  43         extends AbstractQNameStatementSupport<IdentityStatement, IdentityEffectiveStatement> {
  44     private static final @NonNull IdentityStatementSupport RFC6020_INSTANCE = new IdentityStatementSupport(
  45         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  46             .addOptional(YangStmtMapping.BASE)
  47             .addOptional(YangStmtMapping.DESCRIPTION)
  48             .addOptional(YangStmtMapping.REFERENCE)
  49             .addOptional(YangStmtMapping.STATUS)
  50             .build());
  51     private static final @NonNull IdentityStatementSupport RFC7950_INSTANCE = new IdentityStatementSupport(
  52         SubstatementValidator.builder(YangStmtMapping.IDENTITY)
  53             .addAny(YangStmtMapping.BASE)
  54             .addOptional(YangStmtMapping.DESCRIPTION)
  55             .addAny(YangStmtMapping.IF_FEATURE)
  56             .addOptional(YangStmtMapping.REFERENCE)
  57             .addOptional(YangStmtMapping.STATUS)
  58             .build());
  59
  60     private final SubstatementValidator validator;
  61
  62     private IdentityStatementSupport(final SubstatementValidator validator) {
  63         super(YangStmtMapping.IDENTITY, StatementPolicy.reject());
  64         this.validator = requireNonNull(validator);
  65     }
  66
  67     public static @NonNull IdentityStatementSupport rfc6020Instance() {
  68         return RFC6020_INSTANCE;
  69     }
  70
  71     public static @NonNull IdentityStatementSupport rfc7950Instance() {
  72         return RFC7950_INSTANCE;
  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 SubstatementValidator getSubstatementValidator() {
  91         return validator;
  92     }
  93
  94     @Override
  95     protected IdentityStatement createDeclared(final StmtContext<QName, IdentityStatement, ?> ctx,
  96             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  97         return DeclaredStatements.createIdentity(ctx.getArgument(), substatements);
  98     }
  99
 100     @Override
 101     protected IdentityStatement createEmptyDeclared(final StmtContext<QName, IdentityStatement, ?> ctx) {
 102         return DeclaredStatements.createIdentity(ctx.getArgument());
 103     }
 104
 105     @Override
 106     protected IdentityEffectiveStatement createEffective(final Current<QName, IdentityStatement> stmt,
 107             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 108         if (substatements.isEmpty()) {
 109             return new EmptyIdentityEffectiveStatement(stmt.declared(), stmt.effectivePath());
 110         }
 111
 112         final List<IdentitySchemaNode> identities = new ArrayList<>();
 113         for (EffectiveStatement<?, ?> substatement : substatements) {
 114             if (substatement instanceof BaseEffectiveStatement) {
 115                 final QName qname = ((BaseEffectiveStatement) substatement).argument();
 116                 final IdentityEffectiveStatement identity =
 117                         verifyNotNull(stmt.getFromNamespace(IdentityNamespace.class, qname),
 118                             "Failed to find identity %s", qname)
 119                         .buildEffective();
 120                 verify(identity instanceof IdentitySchemaNode, "%s is not a IdentitySchemaNode", identity);
 121                 identities.add((IdentitySchemaNode) identity);
 122             }
 123         }
 124
 125         return new RegularIdentityEffectiveStatement(stmt.declared(), stmt.effectivePath(), new FlagsBuilder()
 126             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 127             .toFlags(), substatements, ImmutableSet.copyOf(identities));
 128     }
 129 }