yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/choice/ImplicitCaseSchemaNode.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.choice;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.Collection;
  15 import java.util.List;
  16 import java.util.Objects;
  17 import java.util.Optional;
  18 import java.util.Set;
  19 import javax.annotation.Nonnull;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  29 import org.opendaylight.yangtools.yang.model.api.Status;
  30 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  33
  34 // FIXME: hide this somewhere
  35 public final class ImplicitCaseSchemaNode implements CaseSchemaNode, DerivableSchemaNode {
  36
  37     private final DataSchemaNode caseShorthandNode;
  38     private final CaseSchemaNode original;
  39     private final SchemaPath path;
  40     private final boolean augmenting;
  41
  42     public ImplicitCaseSchemaNode(final DataSchemaNode caseShorthandNode) {
  43         this.caseShorthandNode = requireNonNull(caseShorthandNode);
  44         this.path = requireNonNull(caseShorthandNode.getPath().getParent());
  45         this.original = getOriginalIfPresent(caseShorthandNode);
  46
  47         // We need to cache this, as it will be reset
  48         this.augmenting = caseShorthandNode.isAugmenting();
  49     }
  50
  51     @Deprecated
  52     @Override
  53     public boolean isAugmenting() {
  54         return augmenting;
  55     }
  56
  57     @Deprecated
  58     @Override
  59     public boolean isAddedByUses() {
  60         return caseShorthandNode.isAddedByUses();
  61     }
  62
  63     @Override
  64     public boolean isConfiguration() {
  65         return caseShorthandNode.isConfiguration();
  66     }
  67
  68     @Nonnull
  69     @Override
  70     public QName getQName() {
  71         return caseShorthandNode.getQName();
  72     }
  73
  74     @Nonnull
  75     @Override
  76     public SchemaPath getPath() {
  77         return path;
  78     }
  79
  80     @Nonnull
  81     @Override
  82     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
  83         return ImmutableList.of();
  84     }
  85
  86     @Override
  87     public Optional<String> getDescription() {
  88         return caseShorthandNode.getDescription();
  89     }
  90
  91     @Override
  92     public Optional<String> getReference() {
  93         return caseShorthandNode.getReference();
  94     }
  95
  96     @Nonnull
  97     @Override
  98     public Status getStatus() {
  99         return caseShorthandNode.getStatus();
 100     }
 101
 102     @Override
 103     public Set<TypeDefinition<?>> getTypeDefinitions() {
 104         return ImmutableSet.of();
 105     }
 106
 107     @Override
 108     public Collection<DataSchemaNode> getChildNodes() {
 109         return ImmutableList.of(caseShorthandNode);
 110     }
 111
 112     @Override
 113     public Set<GroupingDefinition> getGroupings() {
 114         return ImmutableSet.of();
 115     }
 116
 117     @Override
 118     public Optional<DataSchemaNode> findDataChildByName(final QName name) {
 119         return name.equals(getQName()) ? Optional.of(caseShorthandNode) : Optional.empty();
 120     }
 121
 122     @Override
 123     public Set<UsesNode> getUses() {
 124         return ImmutableSet.of();
 125     }
 126
 127     @Override
 128     public Set<AugmentationSchemaNode> getAvailableAugmentations() {
 129         return ImmutableSet.of();
 130     }
 131
 132     @Override
 133     public Optional<? extends SchemaNode> getOriginal() {
 134         return Optional.ofNullable(original);
 135     }
 136
 137     @Override
 138     public Optional<RevisionAwareXPath> getWhenCondition() {
 139         return caseShorthandNode.getWhenCondition();
 140     }
 141
 142     @Override
 143     public int hashCode() {
 144         final int prime = 31;
 145         int result = 1;
 146         result = prime * result + Objects.hashCode(getQName());
 147         result = prime * result + Objects.hashCode(path);
 148         return result;
 149     }
 150
 151     @Override
 152     public boolean equals(final Object obj) {
 153         if (this == obj) {
 154             return true;
 155         }
 156         if (obj == null) {
 157             return false;
 158         }
 159         if (getClass() != obj.getClass()) {
 160             return false;
 161         }
 162         ImplicitCaseSchemaNode other = (ImplicitCaseSchemaNode) obj;
 163         return Objects.equals(getQName(), other.getQName()) && Objects.equals(path, other.path);
 164     }
 165
 166     @Override
 167     public String toString() {
 168         return ImplicitCaseSchemaNode.class.getSimpleName() + "[" + "qname=" + getQName() + "]";
 169     }
 170
 171     private static CaseSchemaNode getOriginalIfPresent(final SchemaNode caseShorthandNode) {
 172         if (caseShorthandNode instanceof DerivableSchemaNode) {
 173             final Optional<? extends SchemaNode> original = ((DerivableSchemaNode) caseShorthandNode).getOriginal();
 174             if (original.isPresent()) {
 175                 return new ImplicitCaseSchemaNode((DataSchemaNode) original.get());
 176             }
 177         }
 178         return null;
 179     }
 180 }