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