yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/UnknownType.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.model.util;
   9
  10 import java.util.Collections;
  11 import java.util.List;
  12
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  15 import org.opendaylight.yangtools.yang.model.api.Status;
  16 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  17 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  18 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  19 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  20 import org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition;
  21
  22 /**
  23  * Utility implementation of unknown type definition.
  24  *
  25  * Unknown type definition is derived type, for
  26  * which base built-in type is not yet known. This types
  27  * are possible during parsing and resolving of YANG model
  28  * without all requisites already processed.
  29  */
  30 public final class UnknownType implements UnknownTypeDefinition {
  31
  32     private final QName name;
  33     private final SchemaPath path;
  34     private final String description;
  35     private final String reference;
  36     private final List<LengthConstraint> lengthStatements;
  37     private final List<PatternConstraint> patterns;
  38     private final List<RangeConstraint> rangeStatements;
  39     private final List<UnknownSchemaNode> extensions;
  40     private final LengthConstraint lengthConstraint;
  41     private final Integer fractionDigits;
  42
  43     private final Status status;
  44     private final String units;
  45     private final Object defaultValue;
  46
  47     public static class Builder {
  48
  49         private final QName name;
  50         private final SchemaPath path;
  51         private String description;
  52         private String reference;
  53
  54         private List<LengthConstraint> lengthStatements = Collections.emptyList();
  55         private List<PatternConstraint> patterns = Collections.emptyList();
  56         private List<RangeConstraint> rangeStatements = Collections.emptyList();
  57         private List<UnknownSchemaNode> extensions = Collections.emptyList();
  58         private LengthConstraint lengthConstraint = null;
  59         private Integer fractionDigits = null;
  60
  61         private Status status = Status.CURRENT;
  62         private String units = "";
  63         private Object defaultValue = null;
  64
  65         public Builder(final QName name, final String description, final String reference) {
  66             this.name = name;
  67             this.path = SchemaPath.create(true, name);
  68             this.description = description;
  69             this.reference = reference;
  70         }
  71
  72         public Builder(final QName name) {
  73             this.name = name;
  74             this.path = SchemaPath.create(true, name);
  75         }
  76
  77         public Builder description(final String description) {
  78             this.description = description;
  79             return this;
  80         }
  81
  82         public Builder reference(final String reference) {
  83             this.reference = reference;
  84             return this;
  85         }
  86
  87         public Builder lengthStatements(final List<LengthConstraint> lengthStatements) {
  88             this.lengthStatements = lengthStatements;
  89             return this;
  90         }
  91
  92         public Builder patterns(final List<PatternConstraint> patterns) {
  93             this.patterns = patterns;
  94             return this;
  95         }
  96
  97         public Builder rangeStatements(final List<RangeConstraint> rangeStatements) {
  98             this.rangeStatements = rangeStatements;
  99             return this;
 100         }
 101
 102         public Builder extensions(final List<UnknownSchemaNode> extensions) {
 103             this.extensions = extensions;
 104             return this;
 105         }
 106
 107         public Builder lengthConstraint(final LengthConstraint lengthConstraint) {
 108             this.lengthConstraint = lengthConstraint;
 109             return this;
 110         }
 111
 112         public Builder fractionDigits(final Integer fractionDigits) {
 113             this.fractionDigits = fractionDigits;
 114             return this;
 115         }
 116
 117         public Builder status(final Status status) {
 118             this.status = status;
 119             return this;
 120         }
 121
 122         public Builder units(final String units) {
 123             this.units = units;
 124             return this;
 125         }
 126
 127         public Builder defaultValue(final Object defaultValue) {
 128             this.defaultValue = defaultValue;
 129             return this;
 130         }
 131
 132         public UnknownTypeDefinition build() {
 133             return new UnknownType(this);
 134         }
 135     }
 136
 137     private UnknownType(final Builder builder) {
 138         this.name = builder.name;
 139         this.path = builder.path;
 140         this.description = builder.description;
 141         this.reference = builder.reference;
 142         this.lengthStatements = builder.lengthStatements;
 143         this.patterns = builder.patterns;
 144         this.rangeStatements = builder.rangeStatements;
 145         this.extensions = builder.extensions;
 146         this.lengthConstraint = builder.lengthConstraint;
 147         this.status = builder.status;
 148         this.units = builder.units;
 149         this.defaultValue = builder.defaultValue;
 150         this.fractionDigits = builder.fractionDigits;
 151     }
 152
 153     /*
 154      * (non-Javadoc)
 155      *
 156      * @see
 157      * org.opendaylight.yangtools.yang.model.api.TypeDefinition#getBaseType()
 158      */
 159     @Override
 160     public UnknownTypeDefinition getBaseType() {
 161         return this;
 162     }
 163
 164     /*
 165      * (non-Javadoc)
 166      *
 167      * @see org.opendaylight.yangtools.yang.model.api.TypeDefinition#getUnits()
 168      */
 169     @Override
 170     public String getUnits() {
 171         return units;
 172     }
 173
 174     /*
 175      * (non-Javadoc)
 176      *
 177      * @see
 178      * org.opendaylight.yangtools.yang.model.api.TypeDefinition#getDefaultValue
 179      * ()
 180      */
 181     @Override
 182     public Object getDefaultValue() {
 183         return defaultValue;
 184     }
 185
 186     /*
 187      * (non-Javadoc)
 188      *
 189      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getQName()
 190      */
 191     @Override
 192     public QName getQName() {
 193         return name;
 194     }
 195
 196     /*
 197      * (non-Javadoc)
 198      *
 199      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getPath()
 200      */
 201     @Override
 202     public SchemaPath getPath() {
 203         return path;
 204     }
 205
 206     /*
 207      * (non-Javadoc)
 208      *
 209      * @see
 210      * org.opendaylight.yangtools.yang.model.api.SchemaNode#getDescription()
 211      */
 212     @Override
 213     public String getDescription() {
 214         return description;
 215     }
 216
 217     /*
 218      * (non-Javadoc)
 219      *
 220      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getReference()
 221      */
 222     @Override
 223     public String getReference() {
 224         return reference;
 225     }
 226
 227     /*
 228      * (non-Javadoc)
 229      *
 230      * @see org.opendaylight.yangtools.yang.model.api.SchemaNode#getStatus()
 231      */
 232     @Override
 233     public Status getStatus() {
 234         return status;
 235     }
 236
 237     /*
 238      * (non-Javadoc)
 239      *
 240      * @see
 241      * org.opendaylight.yangtools.yang.model.api.SchemaNode#getExtensionSchemaNodes
 242      * ()
 243      */
 244     @Override
 245     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 246         return extensions;
 247     }
 248
 249     /*
 250      * (non-Javadoc)
 251      *
 252      * @see org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition
 253      * #getRangeStatements()
 254      */
 255     @Override
 256     public List<RangeConstraint> getRangeConstraints() {
 257         return rangeStatements;
 258     }
 259
 260     /*
 261      * (non-Javadoc)
 262      *
 263      * @see org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition
 264      * #getLengthStatements()
 265      */
 266     @Override
 267     public List<LengthConstraint> getLengthConstraints() {
 268         return lengthStatements;
 269     }
 270
 271     /*
 272      * (non-Javadoc)
 273      *
 274      * @see org.opendaylight.yangtools.yang.model.api.type.UnknownTypeDefinition
 275      * #getPatterns()
 276      */
 277     @Override
 278     public List<PatternConstraint> getPatternConstraints() {
 279         return patterns;
 280     }
 281
 282     @Override
 283     public Integer getFractionDigits() {
 284         return fractionDigits;
 285     }
 286
 287     @Override
 288     public int hashCode() {
 289         final int prime = 31;
 290         int result = 1;
 291         result = prime * result + ((defaultValue == null) ? 0 : defaultValue.hashCode());
 292         result = prime * result + ((description == null) ? 0 : description.hashCode());
 293         result = prime * result + ((extensions == null) ? 0 : extensions.hashCode());
 294         result = prime * result + ((lengthConstraint == null) ? 0 : lengthConstraint.hashCode());
 295         result = prime * result + ((lengthStatements == null) ? 0 : lengthStatements.hashCode());
 296         result = prime * result + ((name == null) ? 0 : name.hashCode());
 297         result = prime * result + ((path == null) ? 0 : path.hashCode());
 298         result = prime * result + ((patterns == null) ? 0 : patterns.hashCode());
 299         result = prime * result + ((rangeStatements == null) ? 0 : rangeStatements.hashCode());
 300         result = prime * result + ((reference == null) ? 0 : reference.hashCode());
 301         result = prime * result + ((status == null) ? 0 : status.hashCode());
 302         result = prime * result + ((units == null) ? 0 : units.hashCode());
 303         return result;
 304     }
 305
 306     @Override
 307     public boolean equals(final Object obj) {
 308         if (this == obj) {
 309             return true;
 310         }
 311         if (obj == null) {
 312             return false;
 313         }
 314         if (getClass() != obj.getClass()) {
 315             return false;
 316         }
 317         UnknownType other = (UnknownType) obj;
 318         if (defaultValue == null) {
 319             if (other.defaultValue != null) {
 320                 return false;
 321             }
 322         } else if (!defaultValue.equals(other.defaultValue)) {
 323             return false;
 324         }
 325         if (description == null) {
 326             if (other.description != null) {
 327                 return false;
 328             }
 329         } else if (!description.equals(other.description)) {
 330             return false;
 331         }
 332         if (extensions == null) {
 333             if (other.extensions != null) {
 334                 return false;
 335             }
 336         } else if (!extensions.equals(other.extensions)) {
 337             return false;
 338         }
 339         if (lengthConstraint == null) {
 340             if (other.lengthConstraint != null) {
 341                 return false;
 342             }
 343         } else if (!lengthConstraint.equals(other.lengthConstraint)) {
 344             return false;
 345         }
 346         if (lengthStatements == null) {
 347             if (other.lengthStatements != null) {
 348                 return false;
 349             }
 350         } else if (!lengthStatements.equals(other.lengthStatements)) {
 351             return false;
 352         }
 353         if (name == null) {
 354             if (other.name != null) {
 355                 return false;
 356             }
 357         } else if (!name.equals(other.name)) {
 358             return false;
 359         }
 360         if (path == null) {
 361             if (other.path != null) {
 362                 return false;
 363             }
 364         } else if (!path.equals(other.path)) {
 365             return false;
 366         }
 367         if (patterns == null) {
 368             if (other.patterns != null) {
 369                 return false;
 370             }
 371         } else if (!patterns.equals(other.patterns)) {
 372             return false;
 373         }
 374         if (rangeStatements == null) {
 375             if (other.rangeStatements != null) {
 376                 return false;
 377             }
 378         } else if (!rangeStatements.equals(other.rangeStatements)) {
 379             return false;
 380         }
 381         if (reference == null) {
 382             if (other.reference != null) {
 383                 return false;
 384             }
 385         } else if (!reference.equals(other.reference)) {
 386             return false;
 387         }
 388         if (status != other.status) {
 389             return false;
 390         }
 391         if (units == null) {
 392             if (other.units != null) {
 393                 return false;
 394             }
 395         } else if (!units.equals(other.units)) {
 396             return false;
 397         }
 398         return true;
 399     }
 400
 401     @Override
 402     public String toString() {
 403         StringBuilder builder2 = new StringBuilder();
 404         builder2.append("UnknownType [name=");
 405         builder2.append(name);
 406         builder2.append(", path=");
 407         builder2.append(path);
 408         builder2.append(", description=");
 409         builder2.append(description);
 410         builder2.append(", reference=");
 411         builder2.append(reference);
 412         builder2.append(", lengthStatements=");
 413         builder2.append(lengthStatements);
 414         builder2.append(", patterns=");
 415         builder2.append(patterns);
 416         builder2.append(", rangeStatements=");
 417         builder2.append(rangeStatements);
 418         builder2.append(", extensions=");
 419         builder2.append(extensions);
 420         builder2.append(", lengthConstraint=");
 421         builder2.append(lengthConstraint);
 422         builder2.append(", status=");
 423         builder2.append(status);
 424         builder2.append(", units=");
 425         builder2.append(units);
 426         builder2.append(", defaultValue=");
 427         builder2.append(defaultValue);
 428         builder2.append("]");
 429         return builder2.toString();
 430     }
 431
 432 }