model/yang-model-spi/src/main/java/org/opendaylight/yangtools/yang/model/spi/meta/AbstractEffectiveUnknownSchmemaNode.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.model.spi.meta;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.Collections2;
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.Collection;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.model.api.CopyableNode;
  19 import org.opendaylight.yangtools.yang.model.api.Status;
  20 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.UnknownStatement;
  24 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DocumentedNodeMixin;
  25
  26 /**
  27  * A declared {@link AbstractDeclaredEffectiveStatement} with {@link UnknownSchemaNode}.
  28  */
  29 @Beta
  30 public abstract class AbstractEffectiveUnknownSchmemaNode<A, D extends UnknownStatement<A>>
  31         extends AbstractDeclaredEffectiveStatement<A, D>
  32         implements DocumentedNodeMixin<A, D>, UnknownSchemaNode {
  33     private final @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements;
  34     private final @NonNull D declared;
  35     private final @NonNull A argument;
  36     private final boolean addedByUses;
  37     private final boolean augmenting;
  38
  39     protected AbstractEffectiveUnknownSchmemaNode(final @NonNull D declared, final A argument,
  40             final CopyableNode history,
  41             final @NonNull ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  42         this.argument = requireNonNull(argument);
  43         this.declared = requireNonNull(declared);
  44         this.substatements = requireNonNull(substatements);
  45         this.augmenting = history.isAugmenting();
  46         this.addedByUses = history.isAddedByUses();
  47     }
  48
  49     @Override
  50     public final A argument() {
  51         return argument;
  52     }
  53
  54     @Override
  55     public final @NonNull D getDeclared() {
  56         return declared;
  57     }
  58
  59     @Override
  60     public final Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
  61         return substatements;
  62     }
  63
  64     @Override
  65     public final QName getNodeType() {
  66         return statementDefinition().getStatementName();
  67     }
  68
  69     @Override
  70     public final String getNodeParameter() {
  71         final String rawArgument = getDeclared().rawArgument();
  72         return rawArgument == null ? "" : rawArgument;
  73     }
  74
  75     @Deprecated
  76     @Override
  77     public final boolean isAddedByUses() {
  78         return addedByUses;
  79     }
  80
  81     @Deprecated
  82     @Override
  83     public final boolean isAugmenting() {
  84         return augmenting;
  85     }
  86
  87     @Override
  88     public String toString() {
  89         final QName type = getNodeType();
  90         return type.getNamespace() + ":" + type.getLocalName() + " " + getNodeParameter();
  91     }
  92
  93     @SuppressWarnings("unchecked")
  94     public final <T> Collection<T> allSubstatementsOfType(final Class<T> type) {
  95         return Collection.class.cast(Collections2.filter(effectiveSubstatements(), type::isInstance));
  96     }
  97
  98     @Override
  99     public final Status getStatus() {
 100         return findFirstEffectiveSubstatementArgument(StatusEffectiveStatement.class).orElse(Status.CURRENT);
 101     }
 102 }