yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/extension/ExtensionEffectiveStatementImpl.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.rfc7950.stmt.extension;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.ArrayDeque;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Deque;
  15 import java.util.List;
  16 import java.util.Objects;
  17 import javax.annotation.Nonnull;
  18 import org.opendaylight.yangtools.util.RecursiveObjectLeaker;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  22 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.YinElementEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractEffectiveDocumentedNode;
  28 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.argument.ArgumentEffectiveStatementImpl;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  30
  31 // FIXME: hide this class
  32 public final class ExtensionEffectiveStatementImpl extends AbstractEffectiveDocumentedNode<QName, ExtensionStatement>
  33         implements ExtensionDefinition, ExtensionEffectiveStatement {
  34     private static final class RecursionDetector extends ThreadLocal<Deque<ExtensionEffectiveStatementImpl>> {
  35         boolean check(final ExtensionEffectiveStatementImpl current) {
  36             final Deque<ExtensionEffectiveStatementImpl> stack = get();
  37             if (stack != null) {
  38                 for (ExtensionEffectiveStatementImpl s : stack) {
  39                     if (s == current) {
  40                         return true;
  41                     }
  42                 }
  43             }
  44             return false;
  45         }
  46
  47         void push(final ExtensionEffectiveStatementImpl current) {
  48             Deque<ExtensionEffectiveStatementImpl> stack = get();
  49             if (stack == null) {
  50                 stack = new ArrayDeque<>(1);
  51                 set(stack);
  52             }
  53
  54             stack.push(current);
  55         }
  56
  57         void pop() {
  58             Deque<ExtensionEffectiveStatementImpl> stack = get();
  59             stack.pop();
  60             if (stack.isEmpty()) {
  61                 remove();
  62             }
  63         }
  64     }
  65
  66     private static final RecursionDetector TOSTRING_DETECTOR = new RecursionDetector();
  67
  68     private final QName qname;
  69     private final String argument;
  70     private final SchemaPath schemaPath;
  71
  72     private final List<UnknownSchemaNode> unknownNodes;
  73     private final boolean yin;
  74
  75     private ExtensionEffectiveStatementImpl(
  76             final StmtContext<QName, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>> ctx) {
  77         super(ctx);
  78         this.qname = ctx.getStatementArgument();
  79         this.schemaPath = ctx.getSchemaPath().get();
  80
  81         final List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
  82         for (EffectiveStatement<?, ?> unknownNode : effectiveSubstatements()) {
  83             if (unknownNode instanceof UnknownSchemaNode) {
  84                 unknownNodesInit.add((UnknownSchemaNode) unknownNode);
  85             }
  86         }
  87         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
  88
  89         // initFields
  90         ArgumentEffectiveStatementImpl argumentSubstatement = firstEffective(ArgumentEffectiveStatementImpl.class);
  91         if (argumentSubstatement != null) {
  92             this.argument = argumentSubstatement.argument().getLocalName();
  93
  94             YinElementEffectiveStatement yinElement = argumentSubstatement
  95                     .firstEffective(YinElementEffectiveStatement.class);
  96             if (yinElement != null) {
  97                 this.yin = yinElement.argument();
  98             } else {
  99                 this.yin = false;
 100             }
 101         } else {
 102             this.argument = null;
 103             this.yin = false;
 104         }
 105     }
 106
 107     /**
 108      * Create a new ExtensionEffectiveStatement, dealing with potential recursion.
 109      *
 110      * @param ctx Statement context
 111      * @return A potentially under-initialized instance
 112      */
 113     static EffectiveStatement<QName, ExtensionStatement> create(
 114             final StmtContext<QName, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>> ctx) {
 115         // Look at the thread-local leak in case we are invoked recursively
 116         final ExtensionEffectiveStatementImpl existing = RecursiveObjectLeaker.lookup(ctx,
 117             ExtensionEffectiveStatementImpl.class);
 118         if (existing != null) {
 119             // Careful! this object is not fully initialized!
 120             return existing;
 121         }
 122
 123         RecursiveObjectLeaker.beforeConstructor(ctx);
 124         try {
 125             // This result is fine, we know it has been completely initialized
 126             return new ExtensionEffectiveStatementImpl(ctx);
 127         } finally {
 128             RecursiveObjectLeaker.afterConstructor(ctx);
 129         }
 130     }
 131
 132     @Override
 133     protected Collection<? extends EffectiveStatement<?, ?>> initSubstatements(
 134             final Collection<? extends StmtContext<?, ?, ?>> substatementsInit) {
 135         // WARNING: this leaks an incompletely-initialized object
 136         RecursiveObjectLeaker.inConstructor(this);
 137
 138         return super.initSubstatements(substatementsInit);
 139     }
 140
 141     @Nonnull
 142     @Override
 143     public QName getQName() {
 144         return qname;
 145     }
 146
 147     @Nonnull
 148     @Override
 149     public SchemaPath getPath() {
 150         return schemaPath;
 151     }
 152
 153     @Nonnull
 154     @Override
 155     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 156         return unknownNodes;
 157     }
 158
 159     @Override
 160     public String getArgument() {
 161         return argument;
 162     }
 163
 164     @Override
 165     public boolean isYinElement() {
 166         return yin;
 167     }
 168
 169     @Override
 170     public int hashCode() {
 171         final int prime = 31;
 172         int result = 1;
 173         result = prime * result + Objects.hashCode(qname);
 174         result = prime * result + Objects.hashCode(schemaPath);
 175         return result;
 176     }
 177
 178     @Override
 179     public boolean equals(final Object obj) {
 180         if (this == obj) {
 181             return true;
 182         }
 183         if (obj == null) {
 184             return false;
 185         }
 186         if (getClass() != obj.getClass()) {
 187             return false;
 188         }
 189         ExtensionEffectiveStatementImpl other = (ExtensionEffectiveStatementImpl) obj;
 190         return Objects.equals(qname, other.qname) && Objects.equals(schemaPath, other.schemaPath);
 191     }
 192
 193     @Override
 194     public String toString() {
 195         if (TOSTRING_DETECTOR.check(this)) {
 196             return recursedToString();
 197         }
 198
 199         TOSTRING_DETECTOR.push(this);
 200         try {
 201             return ExtensionEffectiveStatementImpl.class.getSimpleName() + "["
 202                     + "argument=" + argument
 203                     + ", qname=" + qname
 204                     + ", schemaPath=" + schemaPath
 205                     + ", extensionSchemaNodes=" + unknownNodes
 206                     + ", yin=" + yin
 207                     + "]";
 208         } finally {
 209             TOSTRING_DETECTOR.pop();
 210         }
 211     }
 212
 213     private String recursedToString() {
 214         return ExtensionEffectiveStatementImpl.class.getSimpleName() + "["
 215                 + "argument=" + argument
 216                 + ", qname=" + qname
 217                 + ", schemaPath=" + schemaPath
 218                 + ", yin=" + yin
 219                 + " <RECURSIVE> ]";
 220     }
 221 }