yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementDefinitionContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.reactor;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.MoreObjects.ToStringHelper;
  14 import java.util.HashMap;
  15 import java.util.Map;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.common.QNameModule;
  20 import org.opendaylight.yangtools.yang.model.api.meta.ArgumentDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  24 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  31
  32 public class StatementDefinitionContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
  33     private final @NonNull StatementSupport<A, D, E> support;
  34     private final Map<String, StatementDefinitionContext<?, ?, ?>> argumentSpecificSubDefinitions;
  35     private Map<StatementDefinitionContext<?, ?, ?>, StatementDefinitionContext<?,?,?>> unknownStmtDefsOfYangStmts;
  36
  37     public StatementDefinitionContext(final StatementSupport<A, D, E> support) {
  38         this.support = requireNonNull(support);
  39         this.argumentSpecificSubDefinitions = support.hasArgumentSpecificSupports() ? new HashMap<>() : null;
  40     }
  41
  42     public @NonNull StatementFactory<A, D, E> getFactory() {
  43         return support;
  44     }
  45
  46     public A parseArgumentValue(final StmtContext<A, D, E> context, final String value) {
  47         return support.parseArgumentValue(context, value);
  48     }
  49
  50     public A adaptArgumentValue(final StmtContext<A, D, E> context, final QNameModule targetModule) {
  51         return support.adaptArgumentValue(context, targetModule);
  52     }
  53
  54     public void checkNamespaceAllowed(final Class<? extends IdentifierNamespace<?,?>> namespace) {
  55         // Noop
  56     }
  57
  58     public @NonNull StatementDefinition getPublicView() {
  59         return support.getPublicView();
  60     }
  61
  62     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
  63         return support instanceof ImplicitParentAwareStatementSupport
  64                 ? ((ImplicitParentAwareStatementSupport) support).getImplicitParentFor(stmtDef) : Optional.empty();
  65     }
  66
  67     public boolean onStatementAdded(final Mutable<A, D, E> stmt) {
  68         support.onStatementAdded(stmt);
  69         return false;
  70     }
  71
  72     public void onDeclarationFinished(final Mutable<A, D, E> statement, final ModelProcessingPhase phase) {
  73         switch (phase) {
  74             case SOURCE_PRE_LINKAGE:
  75                 support.onPreLinkageDeclared(statement);
  76                 break;
  77             case SOURCE_LINKAGE:
  78                 support.onLinkageDeclared(statement);
  79                 break;
  80             case STATEMENT_DEFINITION:
  81                 support.onStatementDefinitionDeclared(statement);
  82                 break;
  83             case FULL_DECLARATION:
  84                 support.onFullDefinitionDeclared(statement);
  85                 break;
  86             default:
  87                 break;
  88         }
  89     }
  90
  91     public @NonNull Class<?> getRepresentingClass() {
  92         return support.getDeclaredRepresentationClass();
  93     }
  94
  95     public @NonNull Optional<ArgumentDefinition> getArgumentDefinition() {
  96         return support.getArgumentDefinition();
  97     }
  98
  99     public @NonNull QName getStatementName() {
 100         return support.getStatementName();
 101     }
 102
 103     @Override
 104     public final String toString() {
 105         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 106     }
 107
 108     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 109         return toStringHelper.add("statement", getStatementName());
 110     }
 111
 112     final @NonNull StatementDefinitionContext<?, ?, ?> getSubDefinitionSpecificForArgument(final String argument) {
 113         if (!hasArgumentSpecificSubDefinitions()) {
 114             return this;
 115         }
 116
 117         StatementDefinitionContext<?, ?, ?> potential = argumentSpecificSubDefinitions.get(argument);
 118         if (potential == null) {
 119             final StatementSupport<?, ?, ?> argumentSpecificSupport = support.getSupportSpecificForArgument(argument);
 120             potential = argumentSpecificSupport != null ? new StatementDefinitionContext<>(argumentSpecificSupport)
 121                     : this;
 122             argumentSpecificSubDefinitions.put(argument, potential);
 123         }
 124
 125         return potential;
 126     }
 127
 128     final StatementSupport<A, D, E> support() {
 129         return support;
 130     }
 131
 132     final boolean hasArgumentSpecificSubDefinitions() {
 133         return support.hasArgumentSpecificSupports();
 134     }
 135
 136     final StatementDefinitionContext<?, ?, ?> getAsUnknownStatementDefinition(
 137             final StatementDefinitionContext<?, ?, ?> yangStmtDef) {
 138         if (unknownStmtDefsOfYangStmts != null) {
 139             final StatementDefinitionContext<?, ?, ?> existing = unknownStmtDefsOfYangStmts.get(yangStmtDef);
 140             if (existing != null) {
 141                 return existing;
 142             }
 143         } else {
 144             unknownStmtDefsOfYangStmts = new HashMap<>();
 145         }
 146
 147         @SuppressWarnings("unchecked")
 148         final StatementDefinitionContext<?, ?, ?> ret = support.getUnknownStatementDefinitionOf(
 149             yangStmtDef.getPublicView()).map(StatementDefinitionContext::new).orElse(null);
 150         if (ret != null) {
 151             unknownStmtDefsOfYangStmts.put(yangStmtDef, ret);
 152         }
 153         return ret;
 154     }
 155 }