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