yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/CaseStatementSupport.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 java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  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.meta.StatementSource;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.CaseStatement;
  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.ri.stmt.ImplicitStatements;
  33 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  34 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent.EffectiveConfig;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  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 CaseStatementSupport
  43         extends AbstractImplicitStatementSupport<CaseStatement, CaseEffectiveStatement> {
  44     private static final @NonNull CaseStatementSupport RFC6020_INSTANCE = new CaseStatementSupport(
  45         SubstatementValidator.builder(YangStmtMapping.CASE)
  46             .addAny(YangStmtMapping.ANYXML)
  47             .addAny(YangStmtMapping.CHOICE)
  48             .addAny(YangStmtMapping.CONTAINER)
  49             .addOptional(YangStmtMapping.DESCRIPTION)
  50             .addAny(YangStmtMapping.IF_FEATURE)
  51             .addAny(YangStmtMapping.LEAF)
  52             .addAny(YangStmtMapping.LEAF_LIST)
  53             .addAny(YangStmtMapping.LIST)
  54             .addOptional(YangStmtMapping.REFERENCE)
  55             .addOptional(YangStmtMapping.STATUS)
  56             .addAny(YangStmtMapping.USES)
  57             .addOptional(YangStmtMapping.WHEN)
  58             .build());
  59     private static final @NonNull CaseStatementSupport RFC7950_INSTANCE = new CaseStatementSupport(
  60         SubstatementValidator.builder(YangStmtMapping.CASE)
  61             .addAny(YangStmtMapping.ANYDATA)
  62             .addAny(YangStmtMapping.ANYXML)
  63             .addAny(YangStmtMapping.CHOICE)
  64             .addAny(YangStmtMapping.CONTAINER)
  65             .addOptional(YangStmtMapping.DESCRIPTION)
  66             .addAny(YangStmtMapping.IF_FEATURE)
  67             .addAny(YangStmtMapping.LEAF)
  68             .addAny(YangStmtMapping.LEAF_LIST)
  69             .addAny(YangStmtMapping.LIST)
  70             .addOptional(YangStmtMapping.REFERENCE)
  71             .addOptional(YangStmtMapping.STATUS)
  72             .addAny(YangStmtMapping.USES)
  73             .addOptional(YangStmtMapping.WHEN)
  74             .build());
  75
  76     private final SubstatementValidator validator;
  77
  78     private CaseStatementSupport(final SubstatementValidator validator) {
  79         super(YangStmtMapping.CASE, instantiatedPolicy());
  80         this.validator = requireNonNull(validator);
  81     }
  82
  83     public static @NonNull CaseStatementSupport rfc6020Instance() {
  84         return RFC6020_INSTANCE;
  85     }
  86
  87     public static @NonNull CaseStatementSupport rfc7950Instance() {
  88         return RFC7950_INSTANCE;
  89     }
  90
  91     @Override
  92     protected SubstatementValidator getSubstatementValidator() {
  93         return validator;
  94     }
  95
  96     @Override
  97     protected CaseStatement createDeclared(final StmtContext<QName, CaseStatement, ?> ctx,
  98             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  99         final StatementSource source = ctx.source();
 100         switch (source) {
 101             case CONTEXT:
 102                 return ImplicitStatements.createCase(ctx.getArgument(), substatements);
 103             case DECLARATION:
 104                 return DeclaredStatements.createCase(ctx.getArgument(), substatements);
 105             default:
 106                 throw new IllegalStateException("Unhandled statement source " + source);
 107         }
 108     }
 109
 110     @Override
 111     protected CaseEffectiveStatement copyDeclaredEffective(final Current<QName, CaseStatement> stmt,
 112             final CaseEffectiveStatement original) {
 113         return EffectiveStatements.copyCase(original, stmt.effectivePath(),
 114             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(CaseSchemaNode.class));
 115     }
 116
 117     @Override
 118     protected CaseEffectiveStatement copyUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 119             final CaseEffectiveStatement original) {
 120         return EffectiveStatements.copyCase(original, stmt.effectivePath(),
 121             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(CaseSchemaNode.class));
 122     }
 123
 124     @Override
 125     protected CaseEffectiveStatement createDeclaredEffective(final Current<QName, CaseStatement> stmt,
 126             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 127         try {
 128             return EffectiveStatements.createCase(stmt.declared(), stmt.effectivePath(),
 129                 computeFlags(stmt, substatements), substatements, stmt.original(CaseSchemaNode.class));
 130         } catch (SubstatementIndexingException e) {
 131             throw new SourceException(e.getMessage(), stmt, e);
 132         }
 133     }
 134
 135     @Override
 136     protected CaseEffectiveStatement createUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 137             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 138         try {
 139             return EffectiveStatements.createCase(stmt.effectivePath(), computeFlags(stmt, substatements),
 140                 substatements, stmt.original(CaseSchemaNode.class));
 141         } catch (SubstatementIndexingException e) {
 142             throw new SourceException(e.getMessage(), stmt, e);
 143         }
 144     }
 145
 146     private static int computeFlags(final Current<?, ?> stmt,
 147             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 148         final Boolean config;
 149         final EffectiveConfig effective = stmt.effectiveConfig();
 150         switch (effective) {
 151             case FALSE:
 152                 config = Boolean.FALSE;
 153                 break;
 154             case IGNORED:
 155                 config = null;
 156                 break;
 157             case TRUE:
 158                 final Boolean sub = substatementEffectiveConfig(substatements);
 159                 config = sub != null ? sub : Boolean.TRUE;
 160                 break;
 161             case UNDETERMINED:
 162                 config = substatementEffectiveConfig(substatements);
 163                 break;
 164             default:
 165                 throw new IllegalStateException("Unhandled effective config " + effective);
 166         }
 167
 168         return new FlagsBuilder()
 169                 .setHistory(stmt.history())
 170                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 171                 .setConfiguration(config)
 172                 .toFlags();
 173     }
 174
 175     @SuppressFBWarnings(value = "NP_BOOLEAN_RETURN_NULL", justification = "Internal use tagged with @Nullable")
 176     private static @Nullable Boolean substatementEffectiveConfig(
 177             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 178         for (EffectiveStatement<?, ?> stmt : substatements) {
 179             if (stmt instanceof DataSchemaNode) {
 180                 final Optional<Boolean> opt = ((DataSchemaNode) stmt).effectiveConfig();
 181                 if (opt.isPresent()) {
 182                     return opt.orElseThrow();
 183                 }
 184             }
 185         }
 186         return null;
 187     }
 188 }