yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/ContainerSchemaNodeBuilder.java

   1 /*
   2  * Copyright (c) 2013 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.builder.impl;
   9
  10 import java.net.URI;
  11 import java.util.ArrayList;
  12 import java.util.Date;
  13 import java.util.List;
  14 import java.util.Set;
  15
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  18 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  23 import org.opendaylight.yangtools.yang.model.api.Status;
  24 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  27 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
  28 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
  29 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
  30 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  31 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  32 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
  33 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  34 import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
  35 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  36
  37 import com.google.common.base.Preconditions;
  38 import com.google.common.collect.ImmutableList;
  39 import com.google.common.collect.ImmutableSet;
  40
  41 public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerBuilder implements
  42         AugmentationTargetBuilder, DataSchemaNodeBuilder {
  43     private ContainerSchemaNodeImpl instance;
  44     private boolean presence;
  45     // SchemaNode args
  46     private SchemaPath path;
  47     private String description;
  48     private String reference;
  49     private Status status = Status.CURRENT;
  50     // DataSchemaNode args
  51     private boolean augmenting;
  52     private boolean addedByUses;
  53     private boolean configuration;
  54     private final ConstraintsBuilder constraints;
  55     // AugmentationTarget args
  56     private final List<AugmentationSchema> augmentations = new ArrayList<>();
  57     private final List<AugmentationSchemaBuilder> augmentationBuilders = new ArrayList<>();
  58
  59     public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path) {
  60         super(moduleName, line, qname);
  61         this.path = path;
  62         this.constraints = new ConstraintsBuilder(moduleName, line);
  63     }
  64
  65     // constructor for uses
  66     public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname,
  67             final SchemaPath path, final ContainerSchemaNode base) {
  68         super(moduleName, line, qname);
  69         this.path = path;
  70         constraints = new ConstraintsBuilder(moduleName, line, base.getConstraints());
  71
  72         description = base.getDescription();
  73         reference = base.getReference();
  74         status = base.getStatus();
  75         augmenting = base.isAugmenting();
  76         addedByUses = base.isAddedByUses();
  77         configuration = base.isConfiguration();
  78         presence = base.isPresenceContainer();
  79
  80         URI ns = qname.getNamespace();
  81         Date rev = qname.getRevision();
  82         String pref = qname.getPrefix();
  83         addedChildNodes.addAll(ParserUtils.wrapChildNodes(moduleName, line, base.getChildNodes(), path, ns, rev, pref));
  84         addedGroupings.addAll(ParserUtils.wrapGroupings(moduleName, line, base.getGroupings(), path, ns, rev, pref));
  85         addedTypedefs.addAll(ParserUtils.wrapTypedefs(moduleName, line, base, path, ns, rev, pref));
  86         addedUnknownNodes.addAll(ParserUtils.wrapUnknownNodes(moduleName, line, base.getUnknownSchemaNodes(), path, ns,
  87                 rev, pref));
  88
  89         augmentations.addAll(base.getAvailableAugmentations());
  90         usesNodes.addAll(base.getUses());
  91     }
  92
  93     @Override
  94     public ContainerSchemaNode build() {
  95         if (instance != null) {
  96             return instance;
  97         }
  98
  99         instance = new ContainerSchemaNodeImpl(qname, path);
 100
 101         instance.description = description;
 102         instance.reference = reference;
 103         instance.status = status;
 104         instance.augmenting = augmenting;
 105         instance.addedByUses = addedByUses;
 106         instance.configuration = configuration;
 107         instance.constraints = constraints.build();
 108         instance.presence = presence;
 109
 110         // CHILD NODES
 111         for (DataSchemaNodeBuilder node : addedChildNodes) {
 112             childNodes.put(node.getQName(), node.build());
 113         }
 114         instance.childNodes = ImmutableSet.copyOf(childNodes.values());
 115
 116         // GROUPINGS
 117         for (GroupingBuilder builder : addedGroupings) {
 118             groupings.add(builder.build());
 119         }
 120         instance.groupings = ImmutableSet.copyOf(groupings);
 121
 122         // TYPEDEFS
 123         for (TypeDefinitionBuilder entry : addedTypedefs) {
 124             typedefs.add(entry.build());
 125         }
 126         instance.typeDefinitions = ImmutableSet.copyOf(typedefs);
 127
 128         // USES
 129         for (UsesNodeBuilder builder : addedUsesNodes) {
 130             usesNodes.add(builder.build());
 131         }
 132         instance.uses = ImmutableSet.copyOf(usesNodes);
 133
 134         // AUGMENTATIONS
 135         for (AugmentationSchemaBuilder builder : augmentationBuilders) {
 136             augmentations.add(builder.build());
 137         }
 138         instance.augmentations = ImmutableSet.copyOf(augmentations);
 139
 140         // UNKNOWN NODES
 141         for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
 142             unknownNodes.add(b.build());
 143         }
 144         instance.unknownNodes = ImmutableList.copyOf(unknownNodes);
 145
 146         return instance;
 147     }
 148
 149     @Override
 150     public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
 151         return addedTypedefs;
 152     }
 153
 154     @Override
 155     public void addTypedef(final TypeDefinitionBuilder type) {
 156         String typeName = type.getQName().getLocalName();
 157         for (TypeDefinitionBuilder addedTypedef : addedTypedefs) {
 158             if (addedTypedef.getQName().getLocalName().equals(typeName)) {
 159                 throw new YangParseException(getModuleName(), type.getLine(), "Can not add typedef '" + typeName
 160                         + "': typedef with same name already declared at line " + addedTypedef.getLine());
 161             }
 162         }
 163         addedTypedefs.add(type);
 164     }
 165
 166     public List<AugmentationSchemaBuilder> getAugmentationBuilders() {
 167         return augmentationBuilders;
 168     }
 169
 170     @Override
 171     public void addAugmentation(final AugmentationSchemaBuilder augment) {
 172         augmentationBuilders.add(augment);
 173     }
 174
 175     @Override
 176     public SchemaPath getPath() {
 177         return path;
 178     }
 179
 180     @Override
 181     public void setPath(final SchemaPath path) {
 182         this.path = path;
 183     }
 184
 185     @Override
 186     public String getDescription() {
 187         return description;
 188     }
 189
 190     @Override
 191     public void setDescription(final String description) {
 192         this.description = description;
 193     }
 194
 195     @Override
 196     public String getReference() {
 197         return reference;
 198     }
 199
 200     @Override
 201     public void setReference(final String reference) {
 202         this.reference = reference;
 203     }
 204
 205     @Override
 206     public Status getStatus() {
 207         return status;
 208     }
 209
 210     @Override
 211     public void setStatus(final Status status) {
 212         this.status = Preconditions.checkNotNull(status, "status cannot be null");
 213     }
 214
 215     @Override
 216     public boolean isAugmenting() {
 217         return augmenting;
 218     }
 219
 220     @Override
 221     public void setAugmenting(final boolean augmenting) {
 222         this.augmenting = augmenting;
 223     }
 224
 225     @Override
 226     public boolean isAddedByUses() {
 227         return addedByUses;
 228     }
 229
 230     @Override
 231     public void setAddedByUses(final boolean addedByUses) {
 232         this.addedByUses = addedByUses;
 233     }
 234
 235     @Override
 236     public boolean isConfiguration() {
 237         return configuration;
 238     }
 239
 240     @Override
 241     public void setConfiguration(final boolean configuration) {
 242         this.configuration = configuration;
 243     }
 244
 245     @Override
 246     public ConstraintsBuilder getConstraints() {
 247         return constraints;
 248     }
 249
 250     public boolean isPresence() {
 251         return presence;
 252     }
 253
 254     public void setPresence(final boolean presence) {
 255         this.presence = presence;
 256     }
 257
 258     @Override
 259     public int hashCode() {
 260         final int prime = 31;
 261         int result = 1;
 262         result = prime * result + ((path == null) ? 0 : path.hashCode());
 263         return result;
 264     }
 265
 266     @Override
 267     public boolean equals(final Object obj) {
 268         if (this == obj) {
 269             return true;
 270         }
 271         if (obj == null) {
 272             return false;
 273         }
 274         if (getClass() != obj.getClass()) {
 275             return false;
 276         }
 277         ContainerSchemaNodeBuilder other = (ContainerSchemaNodeBuilder) obj;
 278         if (path == null) {
 279             if (other.path != null) {
 280                 return false;
 281             }
 282         } else if (!path.equals(other.path)) {
 283             return false;
 284         }
 285         // FIXME: Do we really need this? This actually triggers equals
 286         // up to the root builder.
 287         if (getParent() == null) {
 288             if (other.getParent() != null) {
 289                 return false;
 290             }
 291         } else if (!getParent().equals(other.getParent())) {
 292             return false;
 293         }
 294         return true;
 295     }
 296
 297     @Override
 298     public String toString() {
 299         return "container " + qname.getLocalName();
 300     }
 301
 302     private static final class ContainerSchemaNodeImpl implements ContainerSchemaNode {
 303         private final QName qname;
 304         private final SchemaPath path;
 305         private String description;
 306         private String reference;
 307         private Status status;
 308         private boolean augmenting;
 309         private boolean addedByUses;
 310         private boolean configuration;
 311         private ConstraintDefinition constraints;
 312
 313         private ImmutableSet<AugmentationSchema> augmentations;
 314         private ImmutableSet<DataSchemaNode> childNodes;
 315         private ImmutableSet<GroupingDefinition> groupings;
 316         private ImmutableSet<TypeDefinition<?>> typeDefinitions;
 317         private ImmutableSet<UsesNode> uses;
 318         private ImmutableList<UnknownSchemaNode> unknownNodes;
 319
 320         private boolean presence;
 321
 322         private ContainerSchemaNodeImpl(final QName qname, final SchemaPath path) {
 323             this.qname = qname;
 324             this.path = path;
 325         }
 326
 327         @Override
 328         public QName getQName() {
 329             return qname;
 330         }
 331
 332         @Override
 333         public SchemaPath getPath() {
 334             return path;
 335         }
 336
 337         @Override
 338         public String getDescription() {
 339             return description;
 340         }
 341
 342         @Override
 343         public String getReference() {
 344             return reference;
 345         }
 346
 347         @Override
 348         public Status getStatus() {
 349             return status;
 350         }
 351
 352         @Override
 353         public boolean isAugmenting() {
 354             return augmenting;
 355         }
 356
 357         @Override
 358         public boolean isAddedByUses() {
 359             return addedByUses;
 360         }
 361
 362         @Override
 363         public boolean isConfiguration() {
 364             return configuration;
 365         }
 366
 367         @Override
 368         public ConstraintDefinition getConstraints() {
 369             return constraints;
 370         }
 371
 372         @Override
 373         public Set<AugmentationSchema> getAvailableAugmentations() {
 374             return augmentations;
 375         }
 376
 377         @Override
 378         public Set<DataSchemaNode> getChildNodes() {
 379             return childNodes;
 380         }
 381
 382         @Override
 383         public Set<GroupingDefinition> getGroupings() {
 384             return groupings;
 385         }
 386
 387         @Override
 388         public DataSchemaNode getDataChildByName(final QName name) {
 389             return getChildNode(childNodes, name);
 390         }
 391
 392         @Override
 393         public DataSchemaNode getDataChildByName(final String name) {
 394             return getChildNode(childNodes, name);
 395         }
 396
 397         @Override
 398         public Set<UsesNode> getUses() {
 399             return uses;
 400         }
 401
 402         @Override
 403         public boolean isPresenceContainer() {
 404             return presence;
 405         }
 406
 407         @Override
 408         public Set<TypeDefinition<?>> getTypeDefinitions() {
 409             return typeDefinitions;
 410         }
 411
 412         @Override
 413         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 414             return unknownNodes;
 415         }
 416
 417         @Override
 418         public int hashCode() {
 419             final int prime = 31;
 420             int result = 1;
 421             result = prime * result + ((qname == null) ? 0 : qname.hashCode());
 422             result = prime * result + ((path == null) ? 0 : path.hashCode());
 423             return result;
 424         }
 425
 426         @Override
 427         public boolean equals(final Object obj) {
 428             if (this == obj) {
 429                 return true;
 430             }
 431             if (obj == null) {
 432                 return false;
 433             }
 434             if (getClass() != obj.getClass()) {
 435                 return false;
 436             }
 437             ContainerSchemaNodeImpl other = (ContainerSchemaNodeImpl) obj;
 438             if (qname == null) {
 439                 if (other.qname != null) {
 440                     return false;
 441                 }
 442             } else if (!qname.equals(other.qname)) {
 443                 return false;
 444             }
 445             if (path == null) {
 446                 if (other.path != null) {
 447                     return false;
 448                 }
 449             } else if (!path.equals(other.path)) {
 450                 return false;
 451             }
 452             return true;
 453         }
 454
 455         @Override
 456         public String toString() {
 457             return "container " + qname.getLocalName();
 458         }
 459     }
 460
 461 }