yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/UnionTypeBuilder.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.util.ArrayList;
  11 import java.util.Collections;
  12 import java.util.List;
  13
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  16 import org.opendaylight.yangtools.yang.model.api.Status;
  17 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  18 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.YangNode;
  20 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  21 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
  22 import org.opendaylight.yangtools.yang.model.api.type.RangeConstraint;
  23 import org.opendaylight.yangtools.yang.model.util.BaseTypes;
  24 import org.opendaylight.yangtools.yang.model.util.UnionType;
  25 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractTypeAwareBuilder;
  26 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
  27 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  28
  29 /**
  30  * Builder for YANG union type. User can add type to this union as
  31  * TypeDefinition object (resolved type) or in form of TypeDefinitionBuilder.
  32  * When build is called, types in builder form will be built and add to resolved
  33  * types.
  34  */
  35 public final class UnionTypeBuilder extends AbstractTypeAwareBuilder implements TypeDefinitionBuilder {
  36     private static final String NAME = "union";
  37     private static final QName QNAME = BaseTypes.constructQName(NAME);
  38
  39     private final List<TypeDefinition<?>> types;
  40     private final List<TypeDefinitionBuilder> typedefs;
  41     private UnionType instance;
  42     private boolean isBuilt;
  43
  44     public UnionTypeBuilder(final String moduleName, final int line) {
  45         super(moduleName, line, BaseTypes.constructQName(NAME));
  46         types = new ArrayList<TypeDefinition<?>>();
  47         typedefs = new ArrayList<TypeDefinitionBuilder>();
  48     }
  49
  50     public List<TypeDefinition<?>> getTypes() {
  51         return types;
  52     }
  53
  54     @Override
  55     public void setQName(QName qname) {
  56         throw new UnsupportedOperationException("Can not set qname to union type");
  57     }
  58
  59     @Override
  60     public TypeDefinition<?> getType() {
  61         return null;
  62     }
  63
  64     public List<TypeDefinitionBuilder> getTypedefs() {
  65         return typedefs;
  66     }
  67
  68     @Override
  69     public TypeDefinitionBuilder getTypedef() {
  70         return null;
  71     }
  72
  73     @Override
  74     public void setType(final TypeDefinition<?> type) {
  75         types.add(type);
  76     }
  77
  78     @Override
  79     public void setTypedef(final TypeDefinitionBuilder tdb) {
  80         typedefs.add(tdb);
  81     }
  82
  83     @Override
  84     public UnionType build(YangNode parent) {
  85         if (!isBuilt) {
  86             instance = new UnionType(types);
  87             for (TypeDefinitionBuilder tdb : typedefs) {
  88                 types.add(tdb.build(null));
  89             }
  90             isBuilt = true;
  91         }
  92         return instance;
  93     }
  94
  95     @Override
  96     public void setPath(final SchemaPath schemaPath) {
  97         throw new YangParseException(moduleName, line, "Can not set path to " + NAME);
  98     }
  99
 100     @Override
 101     public void setDescription(final String description) {
 102         throw new YangParseException(moduleName, line, "Can not set description to " + NAME);
 103     }
 104
 105     @Override
 106     public void setReference(final String reference) {
 107         throw new YangParseException(moduleName, line, "Can not set reference to " + NAME);
 108     }
 109
 110     @Override
 111     public void setStatus(final Status status) {
 112         throw new YangParseException(moduleName, line, "Can not set status to " + NAME);
 113     }
 114
 115     @Override
 116     public boolean isAddedByUses() {
 117         return false;
 118     }
 119
 120     @Override
 121     public void setAddedByUses(final boolean addedByUses) {
 122         throw new YangParseException(moduleName, line, "Union type can not be added by uses.");
 123     }
 124
 125     @Override
 126     public List<UnknownSchemaNode> getUnknownNodes() {
 127         return Collections.emptyList();
 128     }
 129
 130     @Override
 131     public void addUnknownNodeBuilder(final UnknownSchemaNodeBuilder unknownNode) {
 132         // not yet supported
 133     }
 134
 135     @Override
 136     public SchemaPath getPath() {
 137         return BaseTypes.schemaPath(QNAME);
 138     }
 139
 140     @Override
 141     public String getDescription() {
 142         return null;
 143     }
 144
 145     @Override
 146     public String getReference() {
 147         return null;
 148     }
 149
 150     @Override
 151     public Status getStatus() {
 152         return null;
 153     }
 154
 155     @Override
 156     public List<RangeConstraint> getRanges() {
 157         return Collections.emptyList();
 158     }
 159
 160     @Override
 161     public void setRanges(List<RangeConstraint> ranges) {
 162         throw new YangParseException(moduleName, line, "Can not set ranges to " + NAME);
 163     }
 164
 165     @Override
 166     public List<LengthConstraint> getLengths() {
 167         return Collections.emptyList();
 168     }
 169
 170     @Override
 171     public void setLengths(List<LengthConstraint> lengths) {
 172         throw new YangParseException(moduleName, line, "Can not set lengths to " + NAME);
 173     }
 174
 175     @Override
 176     public List<PatternConstraint> getPatterns() {
 177         return Collections.emptyList();
 178     }
 179
 180     @Override
 181     public void setPatterns(List<PatternConstraint> patterns) {
 182         throw new YangParseException(moduleName, line, "Can not set patterns to " + NAME);
 183     }
 184
 185     @Override
 186     public Integer getFractionDigits() {
 187         return null;
 188     }
 189
 190     @Override
 191     public void setFractionDigits(Integer fractionDigits) {
 192         throw new YangParseException(moduleName, line, "Can not set fraction digits to " + NAME);
 193     }
 194
 195     @Override
 196     public List<UnknownSchemaNodeBuilder> getUnknownNodeBuilders() {
 197         return Collections.emptyList();
 198     }
 199
 200     @Override
 201     public Object getDefaultValue() {
 202         return null;
 203     }
 204
 205     @Override
 206     public void setDefaultValue(Object defaultValue) {
 207         throw new YangParseException(moduleName, line, "Can not set default value to " + NAME);
 208     }
 209
 210     @Override
 211     public String getUnits() {
 212         return null;
 213     }
 214
 215     @Override
 216     public void setUnits(String units) {
 217         throw new YangParseException(moduleName, line, "Can not set units to " + NAME);
 218     }
 219
 220     @Override
 221     public String toString() {
 222         final StringBuilder result = new StringBuilder(UnionTypeBuilder.class.getSimpleName());
 223         result.append("[");
 224         result.append("types=");
 225         result.append(types);
 226         result.append(", typedefs=");
 227         result.append(typedefs);
 228         result.append("]");
 229         return result.toString();
 230     }
 231
 232 }