2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.yang.types;
10 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNode;
11 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findDataSchemaNodeForRelativeXPath;
12 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.findParentModule;
14 import com.google.common.annotations.Beta;
15 import com.google.common.base.Preconditions;
16 import com.google.common.base.Strings;
17 import com.google.common.collect.ImmutableMap;
18 import com.google.common.collect.Sets;
19 import com.google.common.io.BaseEncoding;
20 import java.io.Serializable;
21 import java.math.BigDecimal;
22 import java.math.BigInteger;
23 import java.util.ArrayList;
24 import java.util.Collection;
25 import java.util.Collections;
26 import java.util.Comparator;
27 import java.util.HashMap;
28 import java.util.Iterator;
29 import java.util.List;
31 import java.util.Optional;
33 import java.util.TreeMap;
34 import java.util.regex.Matcher;
35 import java.util.regex.Pattern;
36 import org.opendaylight.mdsal.binding.generator.spi.TypeProvider;
37 import org.opendaylight.mdsal.binding.model.api.AccessModifier;
38 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
39 import org.opendaylight.mdsal.binding.model.api.Enumeration;
40 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
41 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
42 import org.opendaylight.mdsal.binding.model.api.Restrictions;
43 import org.opendaylight.mdsal.binding.model.api.Type;
44 import org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder;
45 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder;
46 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
47 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
48 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
49 import org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder;
50 import org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil;
51 import org.opendaylight.mdsal.binding.model.util.TypeConstants;
52 import org.opendaylight.mdsal.binding.model.util.Types;
53 import org.opendaylight.mdsal.binding.model.util.generated.type.builder.AbstractEnumerationBuilder;
54 import org.opendaylight.mdsal.binding.model.util.generated.type.builder.GeneratedPropertyBuilderImpl;
55 import org.opendaylight.yangtools.yang.binding.BindingMapping;
56 import org.opendaylight.yangtools.yang.common.QName;
57 import org.opendaylight.yangtools.yang.common.Revision;
58 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
59 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
60 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
61 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
62 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
63 import org.opendaylight.yangtools.yang.model.api.Module;
64 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
65 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
66 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
67 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
68 import org.opendaylight.yangtools.yang.model.api.Status;
69 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
70 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
71 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
72 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
73 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
74 import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
75 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
76 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
77 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
78 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
79 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
80 import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
81 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
82 import org.opendaylight.yangtools.yang.model.util.ModuleDependencySort;
83 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
84 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
85 import org.opendaylight.yangtools.yang.model.util.type.BaseTypes;
86 import org.opendaylight.yangtools.yang.model.util.type.CompatUtils;
87 import org.slf4j.Logger;
88 import org.slf4j.LoggerFactory;
91 public abstract class AbstractTypeProvider implements TypeProvider {
92 private static final Logger LOG = LoggerFactory.getLogger(AbstractTypeProvider.class);
93 private static final Pattern GROUPS_PATTERN = Pattern.compile("\\[(.*?)\\]");
94 private static final Pattern NUMBERS_PATTERN = Pattern.compile("[0-9]+\\z");
96 // Backwards compatibility: Union types used to be instantiated in YANG namespace, which is no longer
97 // the case, as unions are emitted to their correct schema path.
98 private static final SchemaPath UNION_PATH = SchemaPath.create(true,
99 org.opendaylight.yangtools.yang.model.util.BaseTypes.UNION_QNAME);
102 * Contains the schema data red from YANG files.
104 private final SchemaContext schemaContext;
107 * Map<moduleName, Map<moduleDate, Map<typeName, type>>>
109 private final Map<String, Map<Optional<Revision>, Map<String, Type>>> genTypeDefsContextMap = new HashMap<>();
112 * The map which maps schema paths to JAVA <code>Type</code>.
114 private final Map<SchemaPath, Type> referencedTypes = new HashMap<>();
115 private final Map<Module, Set<Type>> additionalTypes = new HashMap<>();
118 * Creates new instance of class <code>TypeProviderImpl</code>.
120 * @param schemaContext
121 * contains the schema data red from YANG files
122 * @throws IllegalArgumentException
123 * if <code>schemaContext</code> equal null.
125 AbstractTypeProvider(final SchemaContext schemaContext) {
126 Preconditions.checkArgument(schemaContext != null, "Schema Context cannot be null!");
128 this.schemaContext = schemaContext;
129 resolveTypeDefsFromContext();
133 * Puts <code>refType</code> to map with key <code>refTypePath</code>
136 * schema path used as the map key
138 * type which represents the map value
139 * @throws IllegalArgumentException
141 * <li>if <code>refTypePath</code> equal null</li>
142 * <li>if <code>refType</code> equal null</li>
146 public void putReferencedType(final SchemaPath refTypePath, final Type refType) {
147 Preconditions.checkArgument(refTypePath != null,
148 "Path reference of Enumeration Type Definition cannot be NULL!");
149 Preconditions.checkArgument(refType != null, "Reference to Enumeration Type cannot be NULL!");
150 referencedTypes.put(refTypePath, refType);
153 public Map<Module, Set<Type>> getAdditionalTypes() {
154 return additionalTypes;
159 * Converts basic YANG type <code>type</code> to JAVA <code>Type</code>.
162 * string with YANG name of type
163 * @return JAVA <code>Type</code> for YANG type <code>type</code>
164 * @see TypeProvider#javaTypeForYangType(String)
168 public Type javaTypeForYangType(final String type) {
169 return BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForYangType(type);
173 public Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> typeDefinition, final SchemaNode parentNode) {
174 return javaTypeForSchemaDefinitionType(typeDefinition, parentNode, null);
178 * Converts schema definition type <code>typeDefinition</code> to JAVA
181 * @param typeDefinition
182 * type definition which is converted to JAVA type
183 * @throws IllegalArgumentException
185 * <li>if <code>typeDefinition</code> equal null</li>
186 * <li>if Qname of <code>typeDefinition</code> equal null</li>
187 * <li>if name of <code>typeDefinition</code> equal null</li>
191 public Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> typeDefinition, final SchemaNode parentNode,
192 final Restrictions r) {
193 Preconditions.checkArgument(typeDefinition != null, "Type Definition cannot be NULL!");
194 Preconditions.checkArgument(typeDefinition.getQName() != null,
195 "Type Definition cannot have non specified QName (QName cannot be NULL!)");
196 final String typedefName = typeDefinition.getQName().getLocalName();
197 Preconditions.checkArgument(typedefName != null, "Type Definitions Local Name cannot be NULL!");
199 // Deal with base types
200 if (typeDefinition.getBaseType() == null) {
201 // We have to deal with differing handling of decimal64. The old parser used a fixed Decimal64 type
202 // and generated an enclosing ExtendedType to hold any range constraints. The new parser instantiates
203 // a base type which holds these constraints.
204 if (typeDefinition instanceof DecimalTypeDefinition) {
205 final Type ret = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(typeDefinition,
212 // Deal with leafrefs/identityrefs
213 Type ret = javaTypeForLeafrefOrIdentityRef(typeDefinition, parentNode);
218 // FIXME: it looks as though we could be using the same codepath as above...
219 ret = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForYangType(typeDefinition.getQName().getLocalName());
221 LOG.debug("Failed to resolve Java type for {}", typeDefinition);
227 Type returnType = javaTypeForExtendedType(typeDefinition);
228 if (r != null && returnType instanceof GeneratedTransferObject) {
229 final GeneratedTransferObject gto = (GeneratedTransferObject) returnType;
230 final Module module = findParentModule(schemaContext, parentNode);
231 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
232 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName,
233 typeDefinition.getPath());
234 final String genTOName = BindingMapping.getClassName(typedefName);
235 final String name = packageName + "." + genTOName;
236 if (!returnType.getFullyQualifiedName().equals(name)) {
237 returnType = shadedTOWithRestrictions(gto, r);
243 private GeneratedTransferObject shadedTOWithRestrictions(final GeneratedTransferObject gto, final Restrictions r) {
244 final GeneratedTOBuilder gtob = newGeneratedTOBuilder(gto.getPackageName(), gto.getName());
245 final GeneratedTransferObject parent = gto.getSuperType();
246 if (parent != null) {
247 gtob.setExtendsType(parent);
249 gtob.setRestrictions(r);
250 for (GeneratedProperty gp : gto.getProperties()) {
251 final GeneratedPropertyBuilder gpb = gtob.addProperty(gp.getName());
252 gpb.setValue(gp.getValue());
253 gpb.setReadOnly(gp.isReadOnly());
254 gpb.setAccessModifier(gp.getAccessModifier());
255 gpb.setReturnType(gp.getReturnType());
256 gpb.setFinal(gp.isFinal());
257 gpb.setStatic(gp.isStatic());
259 return gtob.toInstance();
262 private boolean isLeafRefSelfReference(final LeafrefTypeDefinition leafref, final SchemaNode parentNode) {
263 final SchemaNode leafRefValueNode;
264 final RevisionAwareXPath leafRefXPath = leafref.getPathStatement();
265 final RevisionAwareXPath leafRefStrippedXPath = new RevisionAwareXPathImpl(
266 GROUPS_PATTERN.matcher(leafRefXPath.toString()).replaceAll(""), leafRefXPath.isAbsolute());
268 ///// skip leafrefs in augments - they're checked once augments are resolved
269 final Iterator<QName> iterator = parentNode.getPath().getPathFromRoot().iterator();
270 boolean isAugmenting = false;
271 DataNodeContainer current = null;
272 DataSchemaNode dataChildByName;
274 while (iterator.hasNext() && !isAugmenting) {
275 final QName next = iterator.next();
276 if (current == null) {
277 dataChildByName = schemaContext.getDataChildByName(next);
279 dataChildByName = current.getDataChildByName(next);
281 if (dataChildByName != null) {
282 isAugmenting = dataChildByName.isAugmenting();
286 if (dataChildByName instanceof DataNodeContainer) {
287 current = (DataNodeContainer) dataChildByName;
295 final Module parentModule = getParentModule(parentNode);
296 if (!leafRefStrippedXPath.isAbsolute()) {
297 leafRefValueNode = SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, parentModule,
298 parentNode, leafRefStrippedXPath);
300 leafRefValueNode = SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule, leafRefStrippedXPath);
302 return leafRefValueNode != null ? leafRefValueNode.equals(parentNode) : false;
306 * Returns JAVA <code>Type</code> for instances of the type
307 * <code>LeafrefTypeDefinition</code> or
308 * <code>IdentityrefTypeDefinition</code>.
310 * @param typeDefinition
311 * type definition which is converted to JAVA <code>Type</code>
312 * @return JAVA <code>Type</code> instance for <code>typeDefinition</code>
314 private Type javaTypeForLeafrefOrIdentityRef(final TypeDefinition<?> typeDefinition, final SchemaNode parentNode) {
315 if (typeDefinition instanceof LeafrefTypeDefinition) {
316 final LeafrefTypeDefinition leafref = (LeafrefTypeDefinition) typeDefinition;
317 Preconditions.checkArgument(!isLeafRefSelfReference(leafref, parentNode),
318 "Leafref %s is referencing itself, incoming StackOverFlowError detected.", leafref);
319 return provideTypeForLeafref(leafref, parentNode);
320 } else if (typeDefinition instanceof IdentityrefTypeDefinition) {
321 return provideTypeForIdentityref((IdentityrefTypeDefinition) typeDefinition);
328 * Returns JAVA <code>Type</code> for instances of the type
329 * <code>ExtendedType</code>.
331 * @param typeDefinition
332 * type definition which is converted to JAVA <code>Type</code>
333 * @return JAVA <code>Type</code> instance for <code>typeDefinition</code>
335 private Type javaTypeForExtendedType(final TypeDefinition<?> typeDefinition) {
336 final String typedefName = typeDefinition.getQName().getLocalName();
337 final TypeDefinition<?> baseTypeDef = baseTypeDefForExtendedType(typeDefinition);
338 Type returnType = javaTypeForLeafrefOrIdentityRef(baseTypeDef, typeDefinition);
339 if (returnType == null) {
340 if (baseTypeDef instanceof EnumTypeDefinition) {
341 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) baseTypeDef;
342 returnType = provideTypeForEnum(enumTypeDef, typedefName, typeDefinition);
344 final Module module = findParentModule(schemaContext, typeDefinition);
345 final Restrictions r = BindingGeneratorUtil.getRestrictions(typeDefinition);
346 if (module != null) {
347 final Map<Optional<Revision>, Map<String, Type>> modulesByDate = genTypeDefsContextMap.get(
349 final Map<String, Type> genTOs = modulesByDate.get(module.getRevision());
350 if (genTOs != null) {
351 returnType = genTOs.get(typedefName);
353 if (returnType == null) {
354 returnType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(
355 baseTypeDef, typeDefinition, r);
364 * Seeks for identity reference <code>idref</code> the JAVA
365 * <code>type</code>.<br />
369 * If identy which is referenced via <code>idref</code> has name <b>Idn</b>
370 * then returning type is <b>{@code Class<? extends Idn>}</b></i>
373 * identityref type definition for which JAVA <code>Type</code>
375 * @return JAVA <code>Type</code> of the identity which is referenced through
378 private Type provideTypeForIdentityref(final IdentityrefTypeDefinition idref) {
379 final Collection<IdentitySchemaNode> identities = idref.getIdentities();
380 if (identities.size() > 1) {
381 LOG.warn("Identity reference {} has multiple identities, using only the first one", idref);
384 final QName baseIdQName = identities.iterator().next().getQName();
385 final Module module = schemaContext.findModule(baseIdQName.getModule()).orElse(null);
386 IdentitySchemaNode identity = null;
387 for (IdentitySchemaNode id : module.getIdentities()) {
388 if (id.getQName().equals(baseIdQName)) {
392 Preconditions.checkArgument(identity != null, "Target identity '" + baseIdQName + "' do not exists");
394 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
395 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName,
397 final String genTypeName = BindingMapping.getClassName(identity.getQName());
399 final Type baseType = Types.typeForClass(Class.class);
400 final Type paramType = Types.wildcardTypeFor(packageName, genTypeName);
401 return Types.parameterizedTypeFor(baseType, paramType);
405 * Converts <code>typeDefinition</code> to concrete JAVA <code>Type</code>.
407 * @param typeDefinition
408 * type definition which should be converted to JAVA
410 * @return JAVA <code>Type</code> which represents
411 * <code>typeDefinition</code>
412 * @throws IllegalArgumentException
414 * <li>if <code>typeDefinition</code> equal null</li>
415 * <li>if Q name of <code>typeDefinition</code></li>
416 * <li>if name of <code>typeDefinition</code></li>
419 public Type generatedTypeForExtendedDefinitionType(final TypeDefinition<?> typeDefinition, final SchemaNode parentNode) {
420 Preconditions.checkArgument(typeDefinition != null, "Type Definition cannot be NULL!");
421 if (typeDefinition.getQName() == null) {
422 throw new IllegalArgumentException(
423 "Type Definition cannot have non specified QName (QName cannot be NULL!)");
425 Preconditions.checkArgument(typeDefinition.getQName().getLocalName() != null,
426 "Type Definitions Local Name cannot be NULL!");
428 final TypeDefinition<?> baseTypeDef = baseTypeDefForExtendedType(typeDefinition);
429 if (baseTypeDef instanceof LeafrefTypeDefinition || baseTypeDef instanceof IdentityrefTypeDefinition) {
431 * This is backwards compatibility baggage from way back when. The problem at hand is inconsistency between
432 * the fact that identity is mapped to a Class, which is also returned from leaves which specify it like
445 * This results in getFoo() returning Class<? extends Iden>, which looks fine on the surface, but gets more
446 * dicey when we throw in:
460 * Now we have competing requirements: typedef would like us to use encapsulation to capture the defined
461 * type, while getBar() wants us to retain shape with getFoo(), as it should not matter how the identityref
464 * In this particular case getFoo() won just after the Binding Spec was frozen, hence we do not generate
465 * an encapsulation for identityref typedefs.
467 * In case you are thinking we could get by having foo-ref map to a subclass of Iden, that is not a good
468 * option, as it would look as though it is the product of a different construct:
474 * Leading to a rather nice namespace clash and also slight incompatibility with unknown third-party
475 * sub-identities of iden.
477 * The story behind leafrefs is probably similar, but that needs to be ascertained.
482 final Module module = findParentModule(schemaContext, parentNode);
483 if (module != null) {
484 final Map<Optional<Revision>, Map<String, Type>> modulesByDate = genTypeDefsContextMap.get(
486 final Map<String, Type> genTOs = modulesByDate.get(module.getRevision());
487 if (genTOs != null) {
488 return genTOs.get(typeDefinition.getQName().getLocalName());
495 * Gets base type definition for <code>extendTypeDef</code>. The method is
496 * recursively called until non <code>ExtendedType</code> type is found.
498 * @param extendTypeDef
499 * type definition for which is the base type definition sought
500 * @return type definition which is base type for <code>extendTypeDef</code>
501 * @throws IllegalArgumentException
502 * if <code>extendTypeDef</code> equal null
504 private static TypeDefinition<?> baseTypeDefForExtendedType(final TypeDefinition<?> extendTypeDef) {
505 Preconditions.checkArgument(extendTypeDef != null, "Type Definition reference cannot be NULL!");
507 TypeDefinition<?> ret = extendTypeDef;
508 while (ret.getBaseType() != null) {
509 ret = ret.getBaseType();
516 * Converts <code>leafrefType</code> to JAVA <code>Type</code>.
518 * The path of <code>leafrefType</code> is followed to find referenced node
519 * and its <code>Type</code> is returned.
522 * leafref type definition for which is the type sought
523 * @return JAVA <code>Type</code> of data schema node which is referenced in
524 * <code>leafrefType</code>
525 * @throws IllegalArgumentException
527 * <li>if <code>leafrefType</code> equal null</li>
528 * <li>if path statement of <code>leafrefType</code> equal null</li>
532 public Type provideTypeForLeafref(final LeafrefTypeDefinition leafrefType, final SchemaNode parentNode) {
533 Type returnType = null;
534 Preconditions.checkArgument(leafrefType != null, "Leafref Type Definition reference cannot be NULL!");
536 Preconditions.checkArgument(leafrefType.getPathStatement() != null,
537 "The Path Statement for Leafref Type Definition cannot be NULL!");
539 final RevisionAwareXPath xpath = leafrefType.getPathStatement();
540 final String strXPath = xpath.toString();
542 if (strXPath != null) {
543 if (strXPath.indexOf('[') == -1) {
544 final Module module = findParentModule(schemaContext, parentNode);
545 Preconditions.checkArgument(module != null, "Failed to find module for parent %s", parentNode);
547 final SchemaNode dataNode;
548 if (xpath.isAbsolute()) {
549 dataNode = findDataSchemaNode(schemaContext, module, xpath);
551 dataNode = findDataSchemaNodeForRelativeXPath(schemaContext, module, parentNode, xpath);
553 Preconditions.checkArgument(dataNode != null, "Failed to find leafref target: %s in module %s (%s)",
554 strXPath, this.getParentModule(parentNode).getName(), parentNode.getQName().getModule());
556 if (leafContainsEnumDefinition(dataNode)) {
557 returnType = referencedTypes.get(dataNode.getPath());
558 } else if (leafListContainsEnumDefinition(dataNode)) {
559 returnType = Types.listTypeFor(referencedTypes.get(dataNode.getPath()));
561 returnType = resolveTypeFromDataSchemaNode(dataNode);
564 returnType = Types.typeForClass(Object.class);
567 Preconditions.checkArgument(returnType != null, "Failed to find leafref target: %s in module %s (%s)",
568 strXPath, this.getParentModule(parentNode).getName(), parentNode.getQName().getModule(), this);
573 * Checks if <code>dataNode</code> is <code>LeafSchemaNode</code> and if it
574 * so then checks if it is of type <code>EnumTypeDefinition</code>.
577 * data schema node for which is checked if it is leaf and if it
579 * @return boolean value
581 * <li>true - if <code>dataNode</code> is leaf of type enumeration</li>
582 * <li>false - other cases</li>
585 private static boolean leafContainsEnumDefinition(final SchemaNode dataNode) {
586 if (dataNode instanceof LeafSchemaNode) {
587 final LeafSchemaNode leaf = (LeafSchemaNode) dataNode;
588 if (CompatUtils.compatLeafType(leaf) instanceof EnumTypeDefinition) {
596 * Checks if <code>dataNode</code> is <code>LeafListSchemaNode</code> and if
597 * it so then checks if it is of type <code>EnumTypeDefinition</code>.
600 * data schema node for which is checked if it is leaflist and if
602 * @return boolean value
604 * <li>true - if <code>dataNode</code> is leaflist of type
606 * <li>false - other cases</li>
609 private static boolean leafListContainsEnumDefinition(final SchemaNode dataNode) {
610 if (dataNode instanceof LeafListSchemaNode) {
611 final LeafListSchemaNode leafList = (LeafListSchemaNode) dataNode;
612 if (leafList.getType() instanceof EnumTypeDefinition) {
620 * Converts <code>enumTypeDef</code> to
625 * enumeration type definition which is converted to enumeration
627 * string with name which is used as the enumeration name
628 * @return enumeration type which is built with data (name, enum values)
629 * from <code>enumTypeDef</code>
630 * @throws IllegalArgumentException
632 * <li>if <code>enumTypeDef</code> equals null</li>
633 * <li>if enum values of <code>enumTypeDef</code> equal null</li>
634 * <li>if Q name of <code>enumTypeDef</code> equal null</li>
635 * <li>if name of <code>enumTypeDef</code> equal null</li>
638 private Enumeration provideTypeForEnum(final EnumTypeDefinition enumTypeDef, final String enumName,
639 final SchemaNode parentNode) {
640 Preconditions.checkArgument(enumTypeDef != null, "EnumTypeDefinition reference cannot be NULL!");
641 Preconditions.checkArgument(enumTypeDef.getValues() != null,
642 "EnumTypeDefinition MUST contain at least ONE value definition!");
643 Preconditions.checkArgument(enumTypeDef.getQName() != null, "EnumTypeDefinition MUST contain NON-NULL QName!");
644 Preconditions.checkArgument(enumTypeDef.getQName().getLocalName() != null,
645 "Local Name in EnumTypeDefinition QName cannot be NULL!");
647 final String enumerationName = BindingMapping.getClassName(enumName);
649 final Module module = findParentModule(schemaContext, parentNode);
650 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
652 final AbstractEnumerationBuilder enumBuilder = newEnumerationBuilder(basePackageName, enumerationName);
653 addEnumDescription(enumBuilder, enumTypeDef);
654 enumTypeDef.getReference().ifPresent(enumBuilder::setReference);
655 enumBuilder.setModuleName(module.getName());
656 enumBuilder.setSchemaPath(enumTypeDef.getPath());
657 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
658 return enumBuilder.toInstance(null);
662 * Adds enumeration to <code>typeBuilder</code>. The enumeration data are
663 * taken from <code>enumTypeDef</code>.
666 * enumeration type definition is source of enumeration data for
667 * <code>typeBuilder</code>
669 * string with the name of enumeration
671 * generated type builder to which is enumeration added
672 * @return enumeration type which contains enumeration data form
673 * <code>enumTypeDef</code>
674 * @throws IllegalArgumentException
676 * <li>if <code>enumTypeDef</code> equals null</li>
677 * <li>if enum values of <code>enumTypeDef</code> equal null</li>
678 * <li>if Q name of <code>enumTypeDef</code> equal null</li>
679 * <li>if name of <code>enumTypeDef</code> equal null</li>
680 * <li>if name of <code>typeBuilder</code> equal null</li>
684 private Enumeration addInnerEnumerationToTypeBuilder(final EnumTypeDefinition enumTypeDef,
685 final String enumName, final GeneratedTypeBuilderBase<?> typeBuilder) {
686 Preconditions.checkArgument(enumTypeDef != null, "EnumTypeDefinition reference cannot be NULL!");
687 Preconditions.checkArgument(enumTypeDef.getValues() != null,
688 "EnumTypeDefinition MUST contain at least ONE value definition!");
689 Preconditions.checkArgument(enumTypeDef.getQName() != null, "EnumTypeDefinition MUST contain NON-NULL QName!");
690 Preconditions.checkArgument(enumTypeDef.getQName().getLocalName() != null,
691 "Local Name in EnumTypeDefinition QName cannot be NULL!");
692 Preconditions.checkArgument(typeBuilder != null, "Generated Type Builder reference cannot be NULL!");
694 final String enumerationName = BindingMapping.getClassName(enumName);
696 final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
698 addEnumDescription(enumBuilder, enumTypeDef);
699 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
700 return enumBuilder.toInstance(enumBuilder);
703 public abstract void addEnumDescription(EnumBuilder enumBuilder, EnumTypeDefinition enumTypeDef);
705 public abstract AbstractEnumerationBuilder newEnumerationBuilder(String packageName, String name);
707 public abstract GeneratedTOBuilder newGeneratedTOBuilder(String packageName, String name);
709 public abstract GeneratedTypeBuilder newGeneratedTypeBuilder(String packageName, String name);
711 abstract void addCodegenInformation(GeneratedTypeBuilderBase<?> genTOBuilder, TypeDefinition<?> typeDef);
714 * Converts the pattern constraints from <code>typedef</code> to the list of
715 * the strings which represents these constraints.
718 * extended type in which are the pattern constraints sought
719 * @return list of strings which represents the constraint patterns
720 * @throws IllegalArgumentException
721 * if <code>typedef</code> equals null
724 abstract Map<String, String> resolveRegExpressionsFromTypedef(TypeDefinition<?> typedef);
727 * Converts <code>dataNode</code> to JAVA <code>Type</code>.
730 * contains information about YANG type
731 * @return JAVA <code>Type</code> representation of <code>dataNode</code>
733 private Type resolveTypeFromDataSchemaNode(final SchemaNode dataNode) {
734 Type returnType = null;
735 if (dataNode != null) {
736 if (dataNode instanceof LeafSchemaNode) {
737 final LeafSchemaNode leaf = (LeafSchemaNode) dataNode;
738 final TypeDefinition<?> type = CompatUtils.compatLeafType(leaf);
739 returnType = javaTypeForSchemaDefinitionType(type, leaf);
740 } else if (dataNode instanceof LeafListSchemaNode) {
741 final LeafListSchemaNode leafList = (LeafListSchemaNode) dataNode;
742 returnType = javaTypeForSchemaDefinitionType(leafList.getType(), leafList);
749 * Passes through all modules and through all its type definitions and
750 * convert it to generated types.
752 * The modules are firstly sorted by mutual dependencies. The modules are
753 * sequentially passed. All type definitions of a module are at the
754 * beginning sorted so that type definition with less amount of references
755 * to other type definition are processed first.<br />
756 * For each module is created mapping record in the map
757 * {@link AbstractTypeProvider#genTypeDefsContextMap genTypeDefsContextMap}
758 * which map current module name to the map which maps type names to
759 * returned types (generated types).
762 private void resolveTypeDefsFromContext() {
763 final Set<Module> modules = schemaContext.getModules();
764 Preconditions.checkArgument(modules != null, "Set of Modules cannot be NULL!");
765 final List<Module> modulesSortedByDependency = ModuleDependencySort.sort(modules);
767 for (Module module : modulesSortedByDependency) {
768 Map<Optional<Revision>, Map<String, Type>> dateTypeMap = genTypeDefsContextMap.get(module.getName());
769 if (dateTypeMap == null) {
770 dateTypeMap = new HashMap<>();
772 dateTypeMap.put(module.getRevision(), Collections.<String, Type>emptyMap());
773 genTypeDefsContextMap.put(module.getName(), dateTypeMap);
776 for (Module module : modulesSortedByDependency) {
777 if (module != null) {
778 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
779 if (basePackageName != null) {
780 final List<TypeDefinition<?>> typeDefinitions = TypedefResolver.getAllTypedefs(module);
781 for (TypeDefinition<?> typedef : sortTypeDefinitionAccordingDepth(typeDefinitions)) {
782 typedefToGeneratedType(basePackageName, module, typedef);
791 * @param basePackageName
792 * string with name of package to which the module belongs
794 * string with the name of the module for to which the
795 * <code>typedef</code> belongs
797 * type definition of the node for which should be creted JAVA
798 * <code>Type</code> (usually generated TO)
799 * @return JAVA <code>Type</code> representation of <code>typedef</code> or
800 * <code>null</code> value if <code>basePackageName</code> or
801 * <code>modulName</code> or <code>typedef</code> or Q name of
802 * <code>typedef</code> equals <code>null</code>
804 private Type typedefToGeneratedType(final String basePackageName, final Module module,
805 final TypeDefinition<?> typedef) {
806 final String moduleName = module.getName();
807 final Optional<Revision> moduleRevision = module.getRevision();
808 if (basePackageName != null && moduleName != null && typedef != null && typedef.getQName() != null) {
809 final String typedefName = typedef.getQName().getLocalName();
810 final TypeDefinition<?> innerTypeDefinition = typedef.getBaseType();
811 // See generatedTypeForExtendedDefinitionType() above for rationale behind this special case.
812 if (!(innerTypeDefinition instanceof LeafrefTypeDefinition)
813 && !(innerTypeDefinition instanceof IdentityrefTypeDefinition)) {
814 Type returnType = null;
815 if (innerTypeDefinition.getBaseType() != null) {
816 returnType = provideGeneratedTOFromExtendedType(typedef, innerTypeDefinition, basePackageName,
818 } else if (innerTypeDefinition instanceof UnionTypeDefinition) {
819 final GeneratedTOBuilder genTOBuilder = provideGeneratedTOBuilderForUnionTypeDef(basePackageName,
820 (UnionTypeDefinition) innerTypeDefinition, typedefName, typedef);
821 genTOBuilder.setTypedef(true);
822 genTOBuilder.setIsUnion(true);
823 addUnitsToGenTO(genTOBuilder, typedef.getUnits().orElse(null));
824 makeSerializable(genTOBuilder);
825 returnType = genTOBuilder.toInstance();
827 final GeneratedTOBuilder unionBuilder = newGeneratedTOBuilder(genTOBuilder.getPackageName(),
828 genTOBuilder.getName() + "Builder");
829 unionBuilder.setIsUnionBuilder(true);
830 final MethodSignatureBuilder method = unionBuilder.addMethod("getDefaultInstance");
831 method.setReturnType(returnType);
832 method.addParameter(Types.STRING, "defaultValue");
833 method.setAccessModifier(AccessModifier.PUBLIC);
834 method.setStatic(true);
835 Set<Type> types = additionalTypes.get(module);
837 types = Sets.<Type> newHashSet(unionBuilder.toInstance());
838 additionalTypes.put(module, types);
840 types.add(unionBuilder.toInstance());
842 } else if (innerTypeDefinition instanceof EnumTypeDefinition) {
843 // enums are automatically Serializable
844 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) innerTypeDefinition;
845 // TODO units for typedef enum
846 returnType = provideTypeForEnum(enumTypeDef, typedefName, typedef);
847 } else if (innerTypeDefinition instanceof BitsTypeDefinition) {
848 final BitsTypeDefinition bitsTypeDefinition = (BitsTypeDefinition) innerTypeDefinition;
849 final GeneratedTOBuilder genTOBuilder = provideGeneratedTOBuilderForBitsTypeDefinition(
850 basePackageName, bitsTypeDefinition, typedefName, module.getName());
851 genTOBuilder.setTypedef(true);
852 addUnitsToGenTO(genTOBuilder, typedef.getUnits().orElse(null));
853 makeSerializable(genTOBuilder);
854 returnType = genTOBuilder.toInstance();
856 final Type javaType = javaTypeForSchemaDefinitionType(innerTypeDefinition, typedef);
857 returnType = wrapJavaTypeIntoTO(basePackageName, typedef, javaType, module.getName());
859 if (returnType != null) {
860 final Map<Optional<Revision>, Map<String, Type>> modulesByDate =
861 genTypeDefsContextMap.get(moduleName);
862 Map<String, Type> typeMap = modulesByDate.get(moduleRevision);
863 if (typeMap != null) {
864 if (typeMap.isEmpty()) {
865 typeMap = new HashMap<>(4);
866 modulesByDate.put(moduleRevision, typeMap);
868 typeMap.put(typedefName, returnType);
878 * Wraps base YANG type to generated TO.
880 * @param basePackageName
881 * string with name of package to which the module belongs
883 * type definition which is converted to the TO
885 * JAVA <code>Type</code> to which is <code>typedef</code> mapped
886 * @return generated transfer object which represent<code>javaType</code>
888 private GeneratedTransferObject wrapJavaTypeIntoTO(final String basePackageName, final TypeDefinition<?> typedef,
889 final Type javaType, final String moduleName) {
890 Preconditions.checkNotNull(javaType, "javaType cannot be null");
891 final String propertyName = "value";
893 final GeneratedTOBuilder genTOBuilder = typedefToTransferObject(basePackageName, typedef, moduleName);
894 genTOBuilder.setRestrictions(BindingGeneratorUtil.getRestrictions(typedef));
895 final GeneratedPropertyBuilder genPropBuilder = genTOBuilder.addProperty(propertyName);
896 genPropBuilder.setReturnType(javaType);
897 genTOBuilder.addEqualsIdentity(genPropBuilder);
898 genTOBuilder.addHashIdentity(genPropBuilder);
899 genTOBuilder.addToStringProperty(genPropBuilder);
900 if (typedef.getStatus() == Status.DEPRECATED) {
901 genTOBuilder.addAnnotation("", "Deprecated");
903 if (javaType instanceof ConcreteType && "String".equals(javaType.getName()) && typedef.getBaseType() != null) {
904 addStringRegExAsConstant(genTOBuilder, resolveRegExpressionsFromTypedef(typedef));
906 addUnitsToGenTO(genTOBuilder, typedef.getUnits().orElse(null));
907 genTOBuilder.setTypedef(true);
908 makeSerializable(genTOBuilder);
909 return genTOBuilder.toInstance();
913 * Converts output list of generated TO builders to one TO builder (first
914 * from list) which contains the remaining builders as its enclosing TO.
916 * @param basePackageName
917 * string with name of package to which the module belongs
919 * type definition which should be of type
920 * <code>UnionTypeDefinition</code>
922 * string with name for generated TO
923 * @return generated TO builder with the list of enclosed generated TO
926 public GeneratedTOBuilder provideGeneratedTOBuilderForUnionTypeDef(final String basePackageName,
927 final UnionTypeDefinition typedef, final String typeDefName, final SchemaNode parentNode) {
928 final List<GeneratedTOBuilder> builders = provideGeneratedTOBuildersForUnionTypeDef(basePackageName,
929 typedef, typeDefName, parentNode);
930 Preconditions.checkState(!builders.isEmpty(), "No GeneratedTOBuilder objects generated from union %s", typedef);
932 final GeneratedTOBuilder resultTOBuilder = builders.remove(0);
933 builders.forEach(resultTOBuilder::addEnclosingTransferObject);
935 resultTOBuilder.addProperty("value").setReturnType(Types.CHAR_ARRAY);
936 return resultTOBuilder;
940 * Converts <code>typedef</code> to generated TO with
941 * <code>typeDefName</code>. Every union type from <code>typedef</code> is
942 * added to generated TO builder as property.
944 * @param basePackageName
945 * string with name of package to which the module belongs
947 * type definition which should be of type
948 * <code>UnionTypeDefinition</code>
950 * string with name for generated TO
951 * @return generated TO builder which represents <code>typedef</code>
952 * @throws NullPointerException
954 * <li>if <code>basePackageName</code> is null</li>
955 * <li>if <code>typedef</code> is null</li>
956 * <li>if Qname of <code>typedef</code> is null</li>
959 public List<GeneratedTOBuilder> provideGeneratedTOBuildersForUnionTypeDef(final String basePackageName,
960 final UnionTypeDefinition typedef, final String typeDefName, final SchemaNode parentNode) {
961 Preconditions.checkNotNull(basePackageName, "Base Package Name cannot be NULL!");
962 Preconditions.checkNotNull(typedef, "Type Definition cannot be NULL!");
963 Preconditions.checkNotNull(typedef.getQName(), "Type definition QName cannot be NULL!");
965 final List<GeneratedTOBuilder> generatedTOBuilders = new ArrayList<>();
966 final List<TypeDefinition<?>> unionTypes = typedef.getTypes();
967 final Module module = findParentModule(schemaContext, parentNode);
969 final GeneratedTOBuilder unionGenTOBuilder;
970 if (typeDefName != null && !typeDefName.isEmpty()) {
971 final String typeName = BindingMapping.getClassName(typeDefName);
972 unionGenTOBuilder = newGeneratedTOBuilder(basePackageName, typeName);
973 unionGenTOBuilder.setSchemaPath(typedef.getPath());
974 unionGenTOBuilder.setModuleName(module.getName());
975 addCodegenInformation(unionGenTOBuilder, typedef);
977 unionGenTOBuilder = typedefToTransferObject(basePackageName, typedef, module.getName());
980 generatedTOBuilders.add(unionGenTOBuilder);
981 unionGenTOBuilder.setIsUnion(true);
983 // Pattern string is the key, XSD regex is the value. The reason for this choice is that the pattern carries
984 // also negation information and hence guarantees uniqueness.
985 final Map<String, String> expressions = new HashMap<>();
986 for (TypeDefinition<?> unionType : unionTypes) {
987 final String unionTypeName = unionType.getQName().getLocalName();
989 // If we have a base type we should follow the type definition backwards, except for identityrefs, as those
990 // do not follow type encapsulation -- we use the general case for that.
991 if (unionType.getBaseType() != null && !(unionType instanceof IdentityrefTypeDefinition)) {
992 resolveExtendedSubtypeAsUnion(unionGenTOBuilder, unionType, expressions, parentNode);
993 } else if (unionType instanceof UnionTypeDefinition) {
994 generatedTOBuilders.addAll(resolveUnionSubtypeAsUnion(unionGenTOBuilder,
995 (UnionTypeDefinition) unionType, basePackageName, parentNode));
996 } else if (unionType instanceof EnumTypeDefinition) {
997 final Enumeration enumeration = addInnerEnumerationToTypeBuilder((EnumTypeDefinition) unionType,
998 unionTypeName, unionGenTOBuilder);
999 updateUnionTypeAsProperty(unionGenTOBuilder, enumeration, unionTypeName);
1001 final Type javaType = javaTypeForSchemaDefinitionType(unionType, parentNode);
1002 updateUnionTypeAsProperty(unionGenTOBuilder, javaType, unionTypeName);
1005 addStringRegExAsConstant(unionGenTOBuilder, expressions);
1007 storeGenTO(typedef, unionGenTOBuilder, parentNode);
1009 return generatedTOBuilders;
1013 * Wraps code which handle case when union subtype is also of the type
1014 * <code>UnionType</code>.
1016 * In this case the new generated TO is created for union subtype (recursive
1018 * {@link #provideGeneratedTOBuildersForUnionTypeDef(String, UnionTypeDefinition,
1019 * String, SchemaNode)}
1020 * provideGeneratedTOBuilderForUnionTypeDef} and in parent TO builder
1021 * <code>parentUnionGenTOBuilder</code> is created property which type is
1022 * equal to new generated TO.
1024 * @param parentUnionGenTOBuilder
1025 * generated TO builder to which is the property with the child
1026 * union subtype added
1027 * @param basePackageName
1028 * string with the name of the module package
1029 * @param unionSubtype
1030 * type definition which represents union subtype
1031 * @return list of generated TO builders. The number of the builders can be
1032 * bigger one due to recursive call of
1033 * <code>provideGeneratedTOBuildersForUnionTypeDef</code> method.
1035 private List<GeneratedTOBuilder> resolveUnionSubtypeAsUnion(final GeneratedTOBuilder parentUnionGenTOBuilder,
1036 final UnionTypeDefinition unionSubtype, final String basePackageName, final SchemaNode parentNode) {
1037 final String newTOBuilderName = provideAvailableNameForGenTOBuilder(parentUnionGenTOBuilder.getName());
1038 final List<GeneratedTOBuilder> subUnionGenTOBUilders = provideGeneratedTOBuildersForUnionTypeDef(
1039 basePackageName, unionSubtype, newTOBuilderName, parentNode);
1041 final GeneratedPropertyBuilder propertyBuilder;
1042 propertyBuilder = parentUnionGenTOBuilder.addProperty(BindingMapping.getPropertyName(newTOBuilderName));
1043 propertyBuilder.setReturnType(subUnionGenTOBUilders.get(0));
1044 parentUnionGenTOBuilder.addEqualsIdentity(propertyBuilder);
1045 parentUnionGenTOBuilder.addToStringProperty(propertyBuilder);
1047 return subUnionGenTOBUilders;
1051 * Wraps code which handle case when union subtype is of the type
1052 * <code>ExtendedType</code>.
1054 * If TO for this type already exists it is used for the creation of the
1055 * property in <code>parentUnionGenTOBuilder</code>. In other case the base
1056 * type is used for the property creation.
1058 * @param parentUnionGenTOBuilder
1059 * generated TO builder in which new property is created
1060 * @param unionSubtype
1061 * type definition of the <code>ExtendedType</code> type which
1062 * represents union subtype
1063 * @param expressions
1064 * list of strings with the regular expressions
1066 * parent Schema Node for Extended Subtype
1069 private void resolveExtendedSubtypeAsUnion(final GeneratedTOBuilder parentUnionGenTOBuilder,
1070 final TypeDefinition<?> unionSubtype, final Map<String, String> expressions, final SchemaNode parentNode) {
1071 final String unionTypeName = unionSubtype.getQName().getLocalName();
1072 final Type genTO = findGenTO(unionTypeName, unionSubtype);
1073 if (genTO != null) {
1074 updateUnionTypeAsProperty(parentUnionGenTOBuilder, genTO, genTO.getName());
1078 final TypeDefinition<?> baseType = baseTypeDefForExtendedType(unionSubtype);
1079 if (unionTypeName.equals(baseType.getQName().getLocalName())) {
1080 final Type javaType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(baseType,
1082 if (javaType != null) {
1083 updateUnionTypeAsProperty(parentUnionGenTOBuilder, javaType, unionTypeName);
1085 } else if (baseType instanceof LeafrefTypeDefinition) {
1086 final Type javaType = javaTypeForSchemaDefinitionType(baseType, parentNode);
1087 boolean typeExist = false;
1088 for (GeneratedPropertyBuilder generatedPropertyBuilder : parentUnionGenTOBuilder.getProperties()) {
1089 final Type origType = ((GeneratedPropertyBuilderImpl) generatedPropertyBuilder).getReturnType();
1090 if (origType != null && javaType != null && javaType == origType) {
1095 if (!typeExist && javaType != null) {
1096 updateUnionTypeAsProperty(parentUnionGenTOBuilder, javaType,
1097 javaType.getName() + parentUnionGenTOBuilder.getName() + "Value");
1100 if (baseType instanceof StringTypeDefinition) {
1101 expressions.putAll(resolveRegExpressionsFromTypedef(unionSubtype));
1106 * Searches for generated TO for <code>searchedTypeDef</code> type
1107 * definition in {@link #genTypeDefsContextMap genTypeDefsContextMap}
1109 * @param searchedTypeName
1110 * string with name of <code>searchedTypeDef</code>
1111 * @return generated TO for <code>searchedTypeDef</code> or
1112 * <code>null</code> it it doesn't exist
1114 private Type findGenTO(final String searchedTypeName, final SchemaNode parentNode) {
1115 final Module typeModule = findParentModule(schemaContext, parentNode);
1116 if (typeModule != null && typeModule.getName() != null) {
1117 final Map<Optional<Revision>, Map<String, Type>> modulesByDate = genTypeDefsContextMap.get(typeModule.getName());
1118 final Map<String, Type> genTOs = modulesByDate.get(typeModule.getRevision());
1119 if (genTOs != null) {
1120 return genTOs.get(searchedTypeName);
1127 * Stores generated TO created from <code>genTOBuilder</code> for
1128 * <code>newTypeDef</code> to {@link #genTypeDefsContextMap
1129 * genTypeDefsContextMap} if the module for <code>newTypeDef</code> exists
1132 * type definition for which is <code>genTOBuilder</code> created
1133 * @param genTOBuilder
1134 * generated TO builder which is converted to generated TO and
1137 private void storeGenTO(final TypeDefinition<?> newTypeDef, final GeneratedTOBuilder genTOBuilder, final SchemaNode parentNode) {
1138 if (!(newTypeDef instanceof UnionTypeDefinition)) {
1139 final Module parentModule = findParentModule(schemaContext, parentNode);
1140 if (parentModule != null && parentModule.getName() != null) {
1141 final Map<Optional<Revision>, Map<String, Type>> modulesByDate = genTypeDefsContextMap.get(parentModule.getName());
1142 final Map<String, Type> genTOsMap = modulesByDate.get(parentModule.getRevision());
1143 genTOsMap.put(newTypeDef.getQName().getLocalName(), genTOBuilder.toInstance());
1149 * Adds a new property with the name <code>propertyName</code> and with type
1150 * <code>type</code> to <code>unonGenTransObject</code>.
1152 * @param unionGenTransObject
1153 * generated TO to which should be property added
1155 * JAVA <code>type</code> of the property which should be added
1156 * to <code>unionGentransObject</code>
1157 * @param propertyName
1158 * string with name of property which should be added to
1159 * <code>unionGentransObject</code>
1161 private static void updateUnionTypeAsProperty(final GeneratedTOBuilder unionGenTransObject, final Type type, final String propertyName) {
1162 if (unionGenTransObject != null && type != null && !unionGenTransObject.containsProperty(propertyName)) {
1163 final GeneratedPropertyBuilder propBuilder = unionGenTransObject
1164 .addProperty(BindingMapping.getPropertyName(propertyName));
1165 propBuilder.setReturnType(type);
1167 unionGenTransObject.addEqualsIdentity(propBuilder);
1168 unionGenTransObject.addHashIdentity(propBuilder);
1169 unionGenTransObject.addToStringProperty(propBuilder);
1174 * Converts <code>typedef</code> to the generated TO builder.
1176 * @param basePackageName
1177 * string with name of package to which the module belongs
1179 * type definition from which is the generated TO builder created
1180 * @return generated TO builder which contains data from
1181 * <code>typedef</code> and <code>basePackageName</code>
1183 private GeneratedTOBuilder typedefToTransferObject(final String basePackageName,
1184 final TypeDefinition<?> typedef, final String moduleName) {
1186 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, typedef.getPath());
1187 final String typeDefTOName = typedef.getQName().getLocalName();
1189 if (packageName != null && typeDefTOName != null) {
1190 final String genTOName = BindingMapping.getClassName(typeDefTOName);
1191 final GeneratedTOBuilder newType = newGeneratedTOBuilder(packageName, genTOName);
1192 newType.setSchemaPath(typedef.getPath());
1193 newType.setModuleName(moduleName);
1194 addCodegenInformation(newType, typedef);
1201 * Converts <code>typeDef</code> which should be of the type
1202 * <code>BitsTypeDefinition</code> to <code>GeneratedTOBuilder</code>.
1204 * All the bits of the typeDef are added to returning generated TO as
1207 * @param basePackageName
1208 * string with name of package to which the module belongs
1210 * type definition from which is the generated TO builder created
1211 * @param typeDefName
1212 * string with the name for generated TO builder
1213 * @return generated TO builder which represents <code>typeDef</code>
1214 * @throws IllegalArgumentException
1216 * <li>if <code>typeDef</code> equals null</li>
1217 * <li>if <code>basePackageName</code> equals null</li>
1220 public GeneratedTOBuilder provideGeneratedTOBuilderForBitsTypeDefinition(final String basePackageName,
1221 final TypeDefinition<?> typeDef, final String typeDefName, final String moduleName) {
1223 Preconditions.checkArgument(typeDef != null, "typeDef cannot be NULL!");
1224 Preconditions.checkArgument(basePackageName != null, "Base Package Name cannot be NULL!");
1226 if (typeDef instanceof BitsTypeDefinition) {
1227 final BitsTypeDefinition bitsTypeDefinition = (BitsTypeDefinition) typeDef;
1229 final String typeName = BindingMapping.getClassName(typeDefName);
1230 final GeneratedTOBuilder genTOBuilder = newGeneratedTOBuilder(basePackageName, typeName);
1231 genTOBuilder.setSchemaPath(typeDef.getPath());
1232 genTOBuilder.setModuleName(moduleName);
1233 genTOBuilder.setBaseType(typeDef);
1234 addCodegenInformation(genTOBuilder, typeDef);
1236 final List<Bit> bitList = bitsTypeDefinition.getBits();
1237 GeneratedPropertyBuilder genPropertyBuilder;
1238 for (Bit bit : bitList) {
1239 final String name = bit.getName();
1240 genPropertyBuilder = genTOBuilder.addProperty(BindingMapping.getPropertyName(name));
1241 genPropertyBuilder.setReadOnly(true);
1242 genPropertyBuilder.setReturnType(BaseYangTypes.BOOLEAN_TYPE);
1244 genTOBuilder.addEqualsIdentity(genPropertyBuilder);
1245 genTOBuilder.addHashIdentity(genPropertyBuilder);
1246 genTOBuilder.addToStringProperty(genPropertyBuilder);
1249 return genTOBuilder;
1256 * Adds to the <code>genTOBuilder</code> the constant which contains regular
1257 * expressions from the <code>regularExpressions</code>
1259 * @param genTOBuilder
1260 * generated TO builder to which are
1261 * <code>regular expressions</code> added
1262 * @param expressions
1263 * list of string which represent regular expressions
1265 private static void addStringRegExAsConstant(final GeneratedTOBuilder genTOBuilder,
1266 final Map<String, String> expressions) {
1267 if (!expressions.isEmpty()) {
1268 genTOBuilder.addConstant(Types.listTypeFor(BaseYangTypes.STRING_TYPE), TypeConstants.PATTERN_CONSTANT_NAME,
1269 ImmutableMap.copyOf(expressions));
1274 * Creates generated TO with data about inner extended type
1275 * <code>innerExtendedType</code>, about the package name
1276 * <code>typedefName</code> and about the generated TO name
1277 * <code>typedefName</code>.
1279 * It is supposed that <code>innerExtendedType</code> is already present in
1280 * {@link AbstractTypeProvider#genTypeDefsContextMap genTypeDefsContextMap} to
1281 * be possible set it as extended type for the returning generated TO.
1285 * @param innerExtendedType
1286 * extended type which is part of some other extended type
1287 * @param basePackageName
1288 * string with the package name of the module
1291 * @return generated TO which extends generated TO for
1292 * <code>innerExtendedType</code>
1293 * @throws IllegalArgumentException
1295 * <li>if <code>extendedType</code> equals null</li>
1296 * <li>if <code>basePackageName</code> equals null</li>
1297 * <li>if <code>typedefName</code> equals null</li>
1300 private GeneratedTransferObject provideGeneratedTOFromExtendedType(final TypeDefinition<?> typedef,
1301 final TypeDefinition<?> innerExtendedType, final String basePackageName, final String moduleName) {
1302 Preconditions.checkArgument(innerExtendedType != null, "Extended type cannot be NULL!");
1303 Preconditions.checkArgument(basePackageName != null, "String with base package name cannot be NULL!");
1305 final String typedefName = typedef.getQName().getLocalName();
1306 final String classTypedefName = BindingMapping.getClassName(typedefName);
1307 final String innerTypeDef = innerExtendedType.getQName().getLocalName();
1308 final GeneratedTOBuilder genTOBuilder = newGeneratedTOBuilder(basePackageName, classTypedefName);
1309 genTOBuilder.setSchemaPath(typedef.getPath());
1310 genTOBuilder.setModuleName(moduleName);
1311 genTOBuilder.setTypedef(true);
1312 addCodegenInformation(genTOBuilder, typedef);
1314 final Restrictions r = BindingGeneratorUtil.getRestrictions(typedef);
1315 genTOBuilder.setRestrictions(r);
1316 if (typedef.getStatus() == Status.DEPRECATED) {
1317 genTOBuilder.addAnnotation("", "Deprecated");
1320 if (baseTypeDefForExtendedType(innerExtendedType) instanceof UnionTypeDefinition) {
1321 genTOBuilder.setIsUnion(true);
1324 Map<Optional<Revision>, Map<String, Type>> modulesByDate = null;
1325 Map<String, Type> typeMap = null;
1326 final Module parentModule = findParentModule(schemaContext, innerExtendedType);
1327 if (parentModule != null) {
1328 modulesByDate = genTypeDefsContextMap.get(parentModule.getName());
1329 typeMap = modulesByDate.get(parentModule.getRevision());
1332 if (typeMap != null) {
1333 final Type type = typeMap.get(innerTypeDef);
1334 if (type instanceof GeneratedTransferObject) {
1335 genTOBuilder.setExtendsType((GeneratedTransferObject) type);
1338 addUnitsToGenTO(genTOBuilder, typedef.getUnits().orElse(null));
1339 makeSerializable(genTOBuilder);
1341 return genTOBuilder.toInstance();
1345 * Add {@link Serializable} to implemented interfaces of this TO. Also
1346 * compute and add serialVersionUID property.
1349 * transfer object which needs to be serializable
1351 private static void makeSerializable(final GeneratedTOBuilder gto) {
1352 gto.addImplementsType(Types.typeForClass(Serializable.class));
1353 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("serialVersionUID");
1354 prop.setValue(Long.toString(BindingGeneratorUtil.computeDefaultSUID(gto)));
1359 * Finds out for each type definition how many immersion (depth) is
1360 * necessary to get to the base type. Every type definition is inserted to
1361 * the map which key is depth and value is list of type definitions with
1362 * equal depth. In next step are lists from this map concatenated to one
1363 * list in ascending order according to their depth. All type definitions
1364 * are in the list behind all type definitions on which depends.
1366 * @param unsortedTypeDefinitions
1367 * list of type definitions which should be sorted by depth
1368 * @return list of type definitions sorted according their each other
1369 * dependencies (type definitions which are depend on other type
1370 * definitions are in list behind them).
1372 private static List<TypeDefinition<?>> sortTypeDefinitionAccordingDepth(
1373 final Collection<TypeDefinition<?>> unsortedTypeDefinitions) {
1374 final List<TypeDefinition<?>> sortedTypeDefinition = new ArrayList<>();
1376 final Map<Integer, List<TypeDefinition<?>>> typeDefinitionsDepths = new TreeMap<>();
1377 for (TypeDefinition<?> unsortedTypeDefinition : unsortedTypeDefinitions) {
1378 final Integer depth = getTypeDefinitionDepth(unsortedTypeDefinition);
1379 List<TypeDefinition<?>> typeDefinitionsConcreteDepth = typeDefinitionsDepths.get(depth);
1380 if (typeDefinitionsConcreteDepth == null) {
1381 typeDefinitionsConcreteDepth = new ArrayList<>();
1382 typeDefinitionsDepths.put(depth, typeDefinitionsConcreteDepth);
1384 typeDefinitionsConcreteDepth.add(unsortedTypeDefinition);
1387 // SortedMap guarantees order corresponding to keys in ascending order
1388 for (List<TypeDefinition<?>> v : typeDefinitionsDepths.values()) {
1389 sortedTypeDefinition.addAll(v);
1392 return sortedTypeDefinition;
1396 * Returns how many immersion is necessary to get from the type definition
1399 * @param typeDefinition
1400 * type definition for which is depth sought.
1401 * @return number of immersions which are necessary to get from the type
1402 * definition to the base type
1404 private static int getTypeDefinitionDepth(final TypeDefinition<?> typeDefinition) {
1405 // FIXME: rewrite this in a non-recursive manner
1406 if (typeDefinition == null) {
1409 final TypeDefinition<?> baseType = typeDefinition.getBaseType();
1410 if (baseType == null) {
1415 if (baseType.getBaseType() != null) {
1416 depth = depth + getTypeDefinitionDepth(baseType);
1417 } else if (baseType instanceof UnionTypeDefinition) {
1418 final List<TypeDefinition<?>> childTypeDefinitions = ((UnionTypeDefinition) baseType).getTypes();
1419 int maxChildDepth = 0;
1421 for (TypeDefinition<?> childTypeDefinition : childTypeDefinitions) {
1422 childDepth = childDepth + getTypeDefinitionDepth(childTypeDefinition);
1423 if (childDepth > maxChildDepth) {
1424 maxChildDepth = childDepth;
1427 return maxChildDepth;
1433 * Returns string which contains the same value as <code>name</code> but
1434 * integer suffix is incremented by one. If <code>name</code> contains no
1435 * number suffix then number 1 is added.
1438 * string with name of augmented node
1439 * @return string with the number suffix incremented by one (or 1 is added)
1441 private static String provideAvailableNameForGenTOBuilder(final String name) {
1442 final Matcher mtch = NUMBERS_PATTERN.matcher(name);
1444 final int newSuffix = Integer.parseInt(name.substring(mtch.start())) + 1;
1445 return name.substring(0, mtch.start()) + newSuffix;
1451 public static void addUnitsToGenTO(final GeneratedTOBuilder to, final String units) {
1452 if (!Strings.isNullOrEmpty(units)) {
1453 to.addConstant(Types.STRING, "_UNITS", "\"" + units + "\"");
1454 final GeneratedPropertyBuilder prop = new GeneratedPropertyBuilderImpl("UNITS");
1455 prop.setReturnType(Types.STRING);
1456 to.addToStringProperty(prop);
1461 public String getTypeDefaultConstruction(final LeafSchemaNode node) {
1462 return getTypeDefaultConstruction(node, (String) node.getType().getDefaultValue().orElse(null));
1465 public String getTypeDefaultConstruction(final LeafSchemaNode node, final String defaultValue) {
1466 final TypeDefinition<?> type = CompatUtils.compatLeafType(node);
1467 final QName typeQName = type.getQName();
1468 final TypeDefinition<?> base = baseTypeDefForExtendedType(type);
1469 Preconditions.checkNotNull(type, "Cannot provide default construction for null type of %s", node);
1470 Preconditions.checkNotNull(defaultValue, "Cannot provide default construction for null default statement of %s",
1473 final StringBuilder sb = new StringBuilder();
1474 String result = null;
1475 if (base instanceof BinaryTypeDefinition) {
1476 result = binaryToDef(defaultValue);
1477 } else if (base instanceof BitsTypeDefinition) {
1480 final Module parent = getParentModule(node);
1481 final Iterator<QName> path = node.getPath().getPathFromRoot().iterator();
1483 if (!path.hasNext()) {
1484 parentName = BindingMapping.getClassName(parent.getName()) + "Data";
1485 final String basePackageName = BindingMapping.getRootPackageName(parent.getQNameModule());
1486 className = basePackageName + "." + parentName + "." + BindingMapping.getClassName(node.getQName());
1488 final String basePackageName = BindingMapping.getRootPackageName(parent.getQNameModule());
1489 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, type.getPath());
1490 parentName = BindingMapping.getClassName(parent.getName());
1491 className = packageName + "." + parentName + "." + BindingMapping.getClassName(node.getQName());
1493 result = bitsToDef((BitsTypeDefinition) base, className, defaultValue, type.getBaseType() != null);
1494 } else if (base instanceof BooleanTypeDefinition) {
1495 result = typeToBooleanDef(defaultValue);
1496 } else if (base instanceof DecimalTypeDefinition) {
1497 result = typeToDef(BigDecimal.class, defaultValue);
1498 } else if (base instanceof EmptyTypeDefinition) {
1499 result = typeToBooleanDef(defaultValue);
1500 } else if (base instanceof EnumTypeDefinition) {
1501 final char[] defValArray = defaultValue.toCharArray();
1502 final char first = Character.toUpperCase(defaultValue.charAt(0));
1503 defValArray[0] = first;
1504 final String newDefVal = new String(defValArray);
1506 if (type.getBaseType() != null) {
1507 final Module m = getParentModule(type);
1508 final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
1509 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, type.getPath());
1510 className = packageName + "." + BindingMapping.getClassName(typeQName);
1512 final Module parentModule = getParentModule(node);
1513 final String basePackageName = BindingMapping.getRootPackageName(parentModule.getQNameModule());
1514 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, node.getPath());
1515 className = packageName + "." + BindingMapping.getClassName(node.getQName());
1517 result = className + "." + newDefVal;
1518 } else if (base instanceof IdentityrefTypeDefinition) {
1519 throw new UnsupportedOperationException("Cannot get default construction for identityref type");
1520 } else if (base instanceof InstanceIdentifierTypeDefinition) {
1521 throw new UnsupportedOperationException("Cannot get default construction for instance-identifier type");
1522 } else if (BaseTypes.isInt8(base)) {
1523 result = typeToValueOfDef(Byte.class, defaultValue);
1524 } else if (BaseTypes.isInt16(base)) {
1525 result = typeToValueOfDef(Short.class, defaultValue);
1526 } else if (BaseTypes.isInt32(base)) {
1527 result = typeToValueOfDef(Integer.class, defaultValue);
1528 } else if (BaseTypes.isInt64(base)) {
1529 result = typeToValueOfDef(Long.class, defaultValue);
1530 } else if (base instanceof LeafrefTypeDefinition) {
1531 result = leafrefToDef(node, (LeafrefTypeDefinition) base, defaultValue);
1532 } else if (base instanceof StringTypeDefinition) {
1533 result = "\"" + defaultValue + "\"";
1534 } else if (BaseTypes.isUint8(base)) {
1535 result = typeToValueOfDef(Short.class, defaultValue);
1536 } else if (BaseTypes.isUint16(base)) {
1537 result = typeToValueOfDef(Integer.class, defaultValue);
1538 } else if (BaseTypes.isUint32(base)) {
1539 result = typeToValueOfDef(Long.class, defaultValue);
1540 } else if (BaseTypes.isUint64(base)) {
1541 switch (defaultValue) {
1543 result = "java.math.BigInteger.ZERO";
1546 result = "java.math.BigInteger.ONE";
1549 result = "java.math.BigInteger.TEN";
1552 result = typeToDef(BigInteger.class, defaultValue);
1554 } else if (base instanceof UnionTypeDefinition) {
1555 result = unionToDef(node);
1561 if (type.getBaseType() != null && !(base instanceof LeafrefTypeDefinition)
1562 && !(base instanceof EnumTypeDefinition) && !(base instanceof UnionTypeDefinition)) {
1563 final Module m = getParentModule(type);
1564 final String basePackageName = BindingMapping.getRootPackageName(m.getQNameModule());
1565 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, type.getPath());
1566 final String className = packageName + "." + BindingMapping.getClassName(typeQName);
1567 sb.insert(0, "new " + className + "(");
1568 sb.insert(sb.length(), ')');
1571 return sb.toString();
1574 private static String typeToDef(final Class<?> clazz, final String defaultValue) {
1575 return "new " + clazz.getName() + "(\"" + defaultValue + "\")";
1578 private static String typeToValueOfDef(final Class<?> clazz, final String defaultValue) {
1579 return clazz.getName() + ".valueOf(\"" + defaultValue + "\")";
1582 private static String typeToBooleanDef(final String defaultValue) {
1583 switch (defaultValue) {
1585 return "java.lang.Boolean.FALSE";
1587 return "java.lang.Boolean.TRUE";
1589 return typeToValueOfDef(Boolean.class, defaultValue);
1593 private static String binaryToDef(final String defaultValue) {
1594 final StringBuilder sb = new StringBuilder();
1595 final BaseEncoding en = BaseEncoding.base64();
1596 final byte[] encoded = en.decode(defaultValue);
1597 sb.append("new byte[] {");
1598 for (int i = 0; i < encoded.length; i++) {
1599 sb.append(encoded[i]);
1600 if (i != encoded.length - 1) {
1605 return sb.toString();
1608 private static final Comparator<Bit> BIT_NAME_COMPARATOR = (o1, o2) -> o1.getName().compareTo(o2.getName());
1610 private static String bitsToDef(final BitsTypeDefinition type, final String className, final String defaultValue, final boolean isExt) {
1611 final List<Bit> bits = new ArrayList<>(type.getBits());
1612 Collections.sort(bits, BIT_NAME_COMPARATOR);
1613 final StringBuilder sb = new StringBuilder();
1616 sb.append(className);
1619 for (int i = 0; i < bits.size(); i++) {
1620 if (bits.get(i).getName().equals(defaultValue)) {
1625 if (i != bits.size() - 1) {
1632 return sb.toString();
1635 private Module getParentModule(final SchemaNode node) {
1636 final QName qname = node.getPath().getPathFromRoot().iterator().next();
1637 return schemaContext.findModule(qname.getModule()).orElse(null);
1640 private String leafrefToDef(final LeafSchemaNode parentNode, final LeafrefTypeDefinition leafrefType, final String defaultValue) {
1641 Preconditions.checkArgument(leafrefType != null, "Leafref Type Definition reference cannot be NULL!");
1642 Preconditions.checkArgument(leafrefType.getPathStatement() != null,
1643 "The Path Statement for Leafref Type Definition cannot be NULL!");
1645 final RevisionAwareXPath xpath = leafrefType.getPathStatement();
1646 final String strXPath = xpath.toString();
1648 if (strXPath != null) {
1649 if (strXPath.indexOf('[') == -1) {
1650 final Module module = findParentModule(schemaContext, parentNode);
1651 if (module != null) {
1652 final SchemaNode dataNode;
1653 if (xpath.isAbsolute()) {
1654 dataNode = findDataSchemaNode(schemaContext, module, xpath);
1656 dataNode = findDataSchemaNodeForRelativeXPath(schemaContext, module, parentNode, xpath);
1658 final String result = getTypeDefaultConstruction((LeafSchemaNode) dataNode, defaultValue);
1662 return "new java.lang.Object()";
1669 private String unionToDef(final LeafSchemaNode node) {
1670 final TypeDefinition<?> type = CompatUtils.compatLeafType(node);
1674 if (type.getBaseType() != null) {
1675 final QName typeQName = type.getQName();
1676 Module module = null;
1677 final Set<Module> modules = schemaContext.findModules(typeQName.getNamespace());
1678 if (modules.size() > 1) {
1679 for (Module m : modules) {
1680 if (m.getRevision().equals(typeQName.getRevision())) {
1685 if (module == null) {
1686 final List<Module> modulesList = new ArrayList<>(modules);
1687 Collections.sort(modulesList, (o1, o2) -> Revision.compare(o1.getRevision(), o2.getRevision()));
1688 module = modulesList.get(0);
1691 module = modules.iterator().next();
1694 final String basePackageName = BindingMapping.getRootPackageName(module.getQNameModule());
1695 className = basePackageName + "." + BindingMapping.getClassName(typeQName);
1697 final Iterator<QName> path = node.getPath().getPathFromRoot().iterator();
1698 final QName first = path.next();
1699 final Module parent = schemaContext.findModule(first.getModule()).orElse(null);
1700 final String basePackageName = BindingMapping.getRootPackageName(parent.getQNameModule());
1701 if (!path.hasNext()) {
1702 parentName = BindingMapping.getClassName(parent.getName()) + "Data";
1703 className = basePackageName + "." + parentName + "." + BindingMapping.getClassName(node.getQName());
1705 final String packageName = BindingGeneratorUtil.packageNameForGeneratedType(basePackageName, UNION_PATH);
1706 className = packageName + "." + BindingMapping.getClassName(node.getQName());
1709 return union(className, (String) node.getType().getDefaultValue().orElse(null), node);
1712 private static String union(final String className, final String defaultValue, final LeafSchemaNode node) {
1713 final StringBuilder sb = new StringBuilder();
1715 sb.append(className);
1717 sb.append(defaultValue);
1718 sb.append("\".toCharArray())");
1719 return sb.toString();
1723 public String getConstructorPropertyName(final SchemaNode node) {
1724 return node instanceof TypeDefinition<?> ? "value" : "";
1728 public String getParamNameFromType(final TypeDefinition<?> type) {
1729 return BindingMapping.getPropertyName(type.getQName().getLocalName());