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.yangtools.sal.binding.yang.types;
10 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
11 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.List;
18 import java.util.TreeMap;
19 import java.util.regex.Matcher;
20 import java.util.regex.Pattern;
22 import org.apache.commons.lang.StringEscapeUtils;
23 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
24 import org.opendaylight.yangtools.binding.generator.util.TypeConstants;
25 import org.opendaylight.yangtools.binding.generator.util.Types;
26 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.EnumerationBuilderImpl;
27 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
28 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
29 import org.opendaylight.yangtools.sal.binding.model.api.Enumeration;
30 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
31 import org.opendaylight.yangtools.sal.binding.model.api.Type;
32 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
33 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedPropertyBuilder;
34 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
35 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
36 import org.opendaylight.yangtools.yang.common.QName;
37 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.Module;
41 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
42 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
43 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
45 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
46 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
47 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
48 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
49 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
50 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
51 import org.opendaylight.yangtools.yang.model.api.type.PatternConstraint;
52 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
53 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
54 import org.opendaylight.yangtools.yang.model.util.StringType;
55 import org.opendaylight.yangtools.yang.model.util.UnionType;
56 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
58 import com.google.common.base.Preconditions;
60 public final class TypeProviderImpl implements TypeProvider {
62 * Contains the schema data red from YANG files.
64 private final SchemaContext schemaContext;
67 * The outter map maps module names to the map of the types for the module.
68 * The inner map maps the name of the concrete type to the JAVA
69 * <code>Type</code> (usually it is generated TO).
71 private Map<String, Map<String, Type>> genTypeDefsContextMap;
74 * The map which maps schema paths to JAVA <code>Type</code>.
76 private final Map<SchemaPath, Type> referencedTypes;
79 * Creates new instance of class <code>TypeProviderImpl</code>.
81 * @param schemaContext
82 * contains the schema data red from YANG files
83 * @throws IllegalArgumentException
84 * if <code>schemaContext</code> equal null.
86 public TypeProviderImpl(final SchemaContext schemaContext) {
87 Preconditions.checkArgument(schemaContext != null, "Schema Context cannot be null!");
89 this.schemaContext = schemaContext;
90 this.genTypeDefsContextMap = new HashMap<>();
91 this.referencedTypes = new HashMap<>();
92 resolveTypeDefsFromContext();
96 * Puts <code>refType</code> to map with key <code>refTypePath</code>
99 * schema path used as the map key
101 * type which represents the map value
102 * @throws IllegalArgumentException
104 * <li>if <code>refTypePath</code> equal null</li>
105 * <li>if <code>refType</code> equal null</li>
109 public void putReferencedType(final SchemaPath refTypePath, final Type refType) {
110 Preconditions.checkArgument(refTypePath != null,
111 "Path reference of Enumeration Type Definition cannot be NULL!");
112 Preconditions.checkArgument(refType != null, "Reference to Enumeration Type cannot be NULL!");
113 referencedTypes.put(refTypePath, refType);
118 * Converts basic YANG type <code>type</code> to JAVA <code>Type</code>.
121 * string with YANG name of type
122 * @return JAVA <code>Type</code> for YANG type <code>type</code>
123 * @see TypeProvider#javaTypeForYangType(String)
126 public Type javaTypeForYangType(String type) {
127 return BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForYangType(type);
131 * Converts schema definition type <code>typeDefinition</code> to JAVA
134 * @param typeDefinition
135 * type definition which is converted to JAVA type
136 * @throws IllegalArgumentException
138 * <li>if <code>typeDefinition</code> equal null</li>
139 * <li>if Q name of <code>typeDefinition</code> equal null</li>
140 * <li>if name of <code>typeDefinition</code> equal null</li>
144 public Type javaTypeForSchemaDefinitionType(final TypeDefinition<?> typeDefinition, final SchemaNode parentNode) {
145 Type returnType = null;
146 Preconditions.checkArgument(typeDefinition != null, "Type Definition cannot be NULL!");
147 if (typeDefinition.getQName() == null) {
148 throw new IllegalArgumentException(
149 "Type Definition cannot have non specified QName (QName cannot be NULL!)");
151 Preconditions.checkArgument(typeDefinition.getQName().getLocalName() != null,
152 "Type Definitions Local Name cannot be NULL!");
154 if (typeDefinition instanceof ExtendedType) {
155 returnType = javaTypeForExtendedType(typeDefinition);
157 returnType = javaTypeForLeafrefOrIdentityRef(typeDefinition, parentNode);
158 if (returnType == null) {
159 returnType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(typeDefinition,
163 // TODO: add throw exception when we will be able to resolve ALL yang
165 // if (returnType == null) {
166 // throw new IllegalArgumentException("Type Provider can't resolve " +
167 // "type for specified Type Definition " + typedefName);
173 * Returns JAVA <code>Type</code> for instances of the type
174 * <code>LeafrefTypeDefinition</code> or
175 * <code>IdentityrefTypeDefinition</code>.
177 * @param typeDefinition
178 * type definition which is converted to JAVA <code>Type</code>
179 * @return JAVA <code>Type</code> instance for <code>typeDefinition</code>
181 private Type javaTypeForLeafrefOrIdentityRef(TypeDefinition<?> typeDefinition, SchemaNode parentNode) {
182 if (typeDefinition instanceof LeafrefTypeDefinition) {
183 final LeafrefTypeDefinition leafref = (LeafrefTypeDefinition) typeDefinition;
184 return provideTypeForLeafref(leafref, parentNode);
185 } else if (typeDefinition instanceof IdentityrefTypeDefinition) {
186 final IdentityrefTypeDefinition idref = (IdentityrefTypeDefinition) typeDefinition;
187 return provideTypeForIdentityref(idref);
194 * Returns JAVA <code>Type</code> for instances of the type
195 * <code>ExtendedType</code>.
197 * @param typeDefinition
198 * type definition which is converted to JAVA <code>Type</code>
199 * @return JAVA <code>Type</code> instance for <code>typeDefinition</code>
201 private Type javaTypeForExtendedType(TypeDefinition<?> typeDefinition) {
202 final String typedefName = typeDefinition.getQName().getLocalName();
203 final TypeDefinition<?> baseTypeDef = baseTypeDefForExtendedType(typeDefinition);
204 Type returnType = null;
205 returnType = javaTypeForLeafrefOrIdentityRef(baseTypeDef, typeDefinition);
206 if (returnType == null) {
207 if (baseTypeDef instanceof EnumTypeDefinition) {
208 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) baseTypeDef;
209 returnType = provideTypeForEnum(enumTypeDef, typedefName, typeDefinition);
211 final Module module = findParentModule(schemaContext, typeDefinition);
212 if (module != null) {
213 final Map<String, Type> genTOs = genTypeDefsContextMap.get(module.getName());
214 if (genTOs != null) {
215 returnType = genTOs.get(typedefName);
217 if (returnType == null) {
218 returnType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(
219 baseTypeDef, typeDefinition);
225 // TODO: add throw exception when we will be able to resolve ALL yang
227 // if (returnType == null) {
228 // throw new IllegalArgumentException("Type Provider can't resolve " +
229 // "type for specified Type Definition " + typedefName);
234 * Seeks for identity reference <code>idref</code> the JAVA
235 * <code>type</code>.<br />
239 * If identy which is referenced via <code>idref</code> has name <b>Idn</b>
240 * then returning type is <b>{@code Class<? extends Idn>}</b></i>
243 * identityref type definition for which JAVA <code>Type</code>
245 * @return JAVA <code>Type</code> of the identity which is refrenced through
248 private Type provideTypeForIdentityref(IdentityrefTypeDefinition idref) {
249 QName baseIdQName = idref.getIdentity();
250 Module module = schemaContext.findModuleByNamespaceAndRevision(baseIdQName.getNamespace(),
251 baseIdQName.getRevision());
252 IdentitySchemaNode identity = null;
253 for (IdentitySchemaNode id : module.getIdentities()) {
254 if (id.getQName().equals(baseIdQName)) {
258 Preconditions.checkArgument(identity != null, "Target identity '" + baseIdQName + "' do not exists");
260 final String basePackageName = moduleNamespaceToPackageName(module);
261 final String packageName = packageNameForGeneratedType(basePackageName, identity.getPath());
262 final String genTypeName = parseToClassName(identity.getQName().getLocalName());
264 Type baseType = Types.typeForClass(Class.class);
265 Type paramType = Types.wildcardTypeFor(packageName, genTypeName);
266 return Types.parameterizedTypeFor(baseType, paramType);
270 * Converts <code>typeDefinition</code> to concrete JAVA <code>Type</code>.
272 * @param typeDefinition
273 * type definition which should be converted to JAVA
275 * @return JAVA <code>Type</code> which represents
276 * <code>typeDefinition</code>
277 * @throws IllegalArgumentException
279 * <li>if <code>typeDefinition</code> equal null</li>
280 * <li>if Q name of <code>typeDefinition</code></li>
281 * <li>if name of <code>typeDefinition</code></li>
284 public Type generatedTypeForExtendedDefinitionType(final TypeDefinition<?> typeDefinition,
285 final SchemaNode parentNode) {
286 Type returnType = null;
287 Preconditions.checkArgument(typeDefinition != null, "Type Definition cannot be NULL!");
288 if (typeDefinition.getQName() == null) {
289 throw new IllegalArgumentException(
290 "Type Definition cannot have non specified QName (QName cannot be NULL!)");
292 Preconditions.checkArgument(typeDefinition.getQName().getLocalName() != null,
293 "Type Definitions Local Name cannot be NULL!");
295 final String typedefName = typeDefinition.getQName().getLocalName();
296 if (typeDefinition instanceof ExtendedType) {
297 final TypeDefinition<?> baseTypeDef = baseTypeDefForExtendedType(typeDefinition);
299 if (!(baseTypeDef instanceof LeafrefTypeDefinition) && !(baseTypeDef instanceof IdentityrefTypeDefinition)) {
300 final Module module = findParentModule(schemaContext, parentNode);
302 if (module != null) {
303 final Map<String, Type> genTOs = genTypeDefsContextMap.get(module.getName());
304 if (genTOs != null) {
305 returnType = genTOs.get(typedefName);
314 * Gets base type definition for <code>extendTypeDef</code>. The method is
315 * recursivelly called until non <code>ExtendedType</code> type is found.
317 * @param extendTypeDef
318 * type definition for which is the base type definition sought
319 * @return type definition which is base type for <code>extendTypeDef</code>
320 * @throws IllegalArgumentException
321 * if <code>extendTypeDef</code> equal null
323 private TypeDefinition<?> baseTypeDefForExtendedType(final TypeDefinition<?> extendTypeDef) {
324 Preconditions.checkArgument(extendTypeDef != null, "Type Definiition reference cannot be NULL!");
325 final TypeDefinition<?> baseTypeDef = extendTypeDef.getBaseType();
326 if (baseTypeDef instanceof ExtendedType) {
327 return baseTypeDefForExtendedType(baseTypeDef);
335 * Converts <code>leafrefType</code> to JAVA <code>Type</code>.
337 * The path of <code>leafrefType</code> is followed to find referenced node
338 * and its <code>Type</code> is returned.
341 * leafref type definition for which is the type sought
342 * @return JAVA <code>Type</code> of data schema node which is referenced in
343 * <code>leafrefType</code>
344 * @throws IllegalArgumentException
346 * <li>if <code>leafrefType</code> equal null</li>
347 * <li>if path statement of <code>leafrefType</code> equal null</li>
351 public Type provideTypeForLeafref(final LeafrefTypeDefinition leafrefType, final SchemaNode parentNode) {
352 Type returnType = null;
353 Preconditions.checkArgument(leafrefType != null, "Leafref Type Definition reference cannot be NULL!");
355 Preconditions.checkArgument(leafrefType.getPathStatement() != null,
356 "The Path Statement for Leafref Type Definition cannot be NULL!");
358 final RevisionAwareXPath xpath = leafrefType.getPathStatement();
359 final String strXPath = xpath.toString();
361 if (strXPath != null) {
362 if (strXPath.contains("[")) {
363 returnType = Types.typeForClass(Object.class);
365 final Module module = findParentModule(schemaContext, parentNode);
366 if (module != null) {
367 final SchemaNode dataNode;
368 if (xpath.isAbsolute()) {
369 dataNode = findDataSchemaNode(schemaContext, module, xpath);
371 dataNode = findDataSchemaNodeForRelativeXPath(schemaContext, module, parentNode, xpath);
374 if (leafContainsEnumDefinition(dataNode)) {
375 returnType = referencedTypes.get(dataNode.getPath());
376 } else if (leafListContainsEnumDefinition(dataNode)) {
377 returnType = Types.listTypeFor(referencedTypes.get(dataNode.getPath()));
379 returnType = resolveTypeFromDataSchemaNode(dataNode);
388 * Checks if <code>dataNode</code> is <code>LeafSchemaNode</code> and if it
389 * so then checks if it is of type <code>EnumTypeDefinition</code>.
392 * data schema node for which is checked if it is leaf and if it
394 * @return boolean value
396 * <li>true - if <code>dataNode</code> is leaf of type enumeration</li>
397 * <li>false - other cases</li>
400 private boolean leafContainsEnumDefinition(final SchemaNode dataNode) {
401 if (dataNode instanceof LeafSchemaNode) {
402 final LeafSchemaNode leaf = (LeafSchemaNode) dataNode;
403 if (leaf.getType() instanceof EnumTypeDefinition) {
411 * Checks if <code>dataNode</code> is <code>LeafListSchemaNode</code> and if
412 * it so then checks if it is of type <code>EnumTypeDefinition</code>.
415 * data schema node for which is checked if it is leaflist and if
417 * @return boolean value
419 * <li>true - if <code>dataNode</code> is leaflist of type
421 * <li>false - other cases</li>
424 private boolean leafListContainsEnumDefinition(final SchemaNode dataNode) {
425 if (dataNode instanceof LeafListSchemaNode) {
426 final LeafListSchemaNode leafList = (LeafListSchemaNode) dataNode;
427 if (leafList.getType() instanceof EnumTypeDefinition) {
435 * Converts <code>enumTypeDef</code> to
436 * {@link org.opendaylight.yangtools.sal.binding.model.api.Enumeration
440 * enumeration type definition which is converted to enumeration
442 * string with name which is used as the enumeration name
443 * @return enumeration type which is built with data (name, enum values)
444 * from <code>enumTypeDef</code>
445 * @throws IllegalArgumentException
447 * <li>if <code>enumTypeDef</code> equals null</li>
448 * <li>if enum values of <code>enumTypeDef</code> equal null</li>
449 * <li>if Q name of <code>enumTypeDef</code> equal null</li>
450 * <li>if name of <code>enumTypeDef</code> equal null</li>
453 private Enumeration provideTypeForEnum(final EnumTypeDefinition enumTypeDef, final String enumName,
454 final SchemaNode parentNode) {
455 Preconditions.checkArgument(enumTypeDef != null, "EnumTypeDefinition reference cannot be NULL!");
456 Preconditions.checkArgument(enumTypeDef.getValues() != null,
457 "EnumTypeDefinition MUST contain at least ONE value definition!");
458 Preconditions.checkArgument(enumTypeDef.getQName() != null, "EnumTypeDefinition MUST contain NON-NULL QName!");
459 Preconditions.checkArgument(enumTypeDef.getQName().getLocalName() != null,
460 "Local Name in EnumTypeDefinition QName cannot be NULL!");
462 final String enumerationName = parseToClassName(enumName);
464 Module module = findParentModule(schemaContext, parentNode);
465 final String basePackageName = moduleNamespaceToPackageName(module);
467 final EnumBuilder enumBuilder = new EnumerationBuilderImpl(basePackageName, enumerationName);
468 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
469 return enumBuilder.toInstance(null);
473 * Adds enumeration to <code>typeBuilder</code>. The enumeration data are
474 * taken from <code>enumTypeDef</code>.
477 * enumeration type definition is source of enumeration data for
478 * <code>typeBuilder</code>
480 * string with the name of enumeration
482 * generated type builder to which is enumeration added
483 * @return enumeration type which contains enumeration data form
484 * <code>enumTypeDef</code>
485 * @throws IllegalArgumentException
487 * <li>if <code>enumTypeDef</code> equals null</li>
488 * <li>if enum values of <code>enumTypeDef</code> equal null</li>
489 * <li>if Q name of <code>enumTypeDef</code> equal null</li>
490 * <li>if name of <code>enumTypeDef</code> equal null</li>
491 * <li>if name of <code>typeBuilder</code> equal null</li>
495 private Enumeration addInnerEnumerationToTypeBuilder(final EnumTypeDefinition enumTypeDef, final String enumName,
496 final GeneratedTypeBuilderBase<?> typeBuilder) {
497 Preconditions.checkArgument(enumTypeDef != null, "EnumTypeDefinition reference cannot be NULL!");
498 Preconditions.checkArgument(enumTypeDef.getValues() != null,
499 "EnumTypeDefinition MUST contain at least ONE value definition!");
500 Preconditions.checkArgument(enumTypeDef.getQName() != null, "EnumTypeDefinition MUST contain NON-NULL QName!");
501 Preconditions.checkArgument(enumTypeDef.getQName().getLocalName() != null,
502 "Local Name in EnumTypeDefinition QName cannot be NULL!");
503 Preconditions.checkArgument(typeBuilder != null, "Generated Type Builder reference cannot be NULL!");
505 final String enumerationName = parseToClassName(enumName);
507 final EnumBuilder enumBuilder = typeBuilder.addEnumeration(enumerationName);
508 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
509 return enumBuilder.toInstance(enumBuilder);
513 * Converts <code>dataNode</code> to JAVA <code>Type</code>.
516 * contains information about YANG type
517 * @return JAVA <code>Type</code> representation of <code>dataNode</code>
519 private Type resolveTypeFromDataSchemaNode(final SchemaNode dataNode) {
520 Type returnType = null;
521 if (dataNode != null) {
522 if (dataNode instanceof LeafSchemaNode) {
523 final LeafSchemaNode leaf = (LeafSchemaNode) dataNode;
524 returnType = javaTypeForSchemaDefinitionType(leaf.getType(), leaf);
525 } else if (dataNode instanceof LeafListSchemaNode) {
526 final LeafListSchemaNode leafList = (LeafListSchemaNode) dataNode;
527 returnType = javaTypeForSchemaDefinitionType(leafList.getType(), leafList);
534 * Passes through all modules and through all its type definitions and
535 * convert it to generated types.
537 * The modules are firstly sorted by mutual dependencies. The modules are
538 * sequentially passed. All type definitions of a module are at the
539 * beginning sorted so that type definition with less amount of references
540 * to other type definition are processed first.<br />
541 * For each module is created mapping record in the map
542 * {@link TypeProviderImpl#genTypeDefsContextMap genTypeDefsContextMap}
543 * which map current module name to the map which maps type names to
544 * returned types (generated types).
547 private void resolveTypeDefsFromContext() {
548 final Set<Module> modules = schemaContext.getModules();
549 Preconditions.checkArgument(modules != null, "Sef of Modules cannot be NULL!");
550 final Module[] modulesArray = new Module[modules.size()];
552 for (Module modul : modules) {
553 modulesArray[i++] = modul;
555 final List<Module> modulesSortedByDependency = ModuleDependencySort.sort(modulesArray);
557 for (final Module module : modulesSortedByDependency) {
558 if (module == null) {
561 final String moduleName = module.getName();
562 final String basePackageName = moduleNamespaceToPackageName(module);
564 final Set<TypeDefinition<?>> typeDefinitions = module.getTypeDefinitions();
565 final List<TypeDefinition<?>> listTypeDefinitions = sortTypeDefinitionAccordingDepth(typeDefinitions);
567 final Map<String, Type> typeMap = new HashMap<>();
568 genTypeDefsContextMap.put(moduleName, typeMap);
570 if ((listTypeDefinitions != null) && (basePackageName != null)) {
571 for (final TypeDefinition<?> typedef : listTypeDefinitions) {
572 typedefToGeneratedType(basePackageName, moduleName, typedef);
580 * @param basePackageName
581 * string with name of package to which the module belongs
583 * string with the name of the module for to which the
584 * <code>typedef</code> belongs
586 * type definition of the node for which should be creted JAVA
587 * <code>Type</code> (usually generated TO)
588 * @return JAVA <code>Type</code> representation of <code>typedef</code> or
589 * <code>null</code> value if <code>basePackageName</code> or
590 * <code>modulName</code> or <code>typedef</code> or Q name of
591 * <code>typedef</code> equals <code>null</code>
593 private Type typedefToGeneratedType(final String basePackageName, final String moduleName,
594 final TypeDefinition<?> typedef) {
595 if ((basePackageName != null) && (moduleName != null) && (typedef != null) && (typedef.getQName() != null)) {
597 final String typedefName = typedef.getQName().getLocalName();
598 final TypeDefinition<?> innerTypeDefinition = typedef.getBaseType();
599 if (!(innerTypeDefinition instanceof LeafrefTypeDefinition)
600 && !(innerTypeDefinition instanceof IdentityrefTypeDefinition)) {
601 Type returnType = null;
602 if (innerTypeDefinition instanceof ExtendedType) {
603 ExtendedType innerExtendedType = (ExtendedType) innerTypeDefinition;
604 returnType = provideGeneratedTOFromExtendedType(innerExtendedType, basePackageName, typedefName);
605 } else if (innerTypeDefinition instanceof UnionTypeDefinition) {
606 final GeneratedTOBuilder genTOBuilder = provideGeneratedTOBuilderForUnionTypeDef(basePackageName,
607 (UnionTypeDefinition) innerTypeDefinition, typedefName, typedef);
608 returnType = genTOBuilder.toInstance();
609 } else if (innerTypeDefinition instanceof EnumTypeDefinition) {
610 final EnumTypeDefinition enumTypeDef = (EnumTypeDefinition) innerTypeDefinition;
611 returnType = provideTypeForEnum(enumTypeDef, typedefName, typedef);
613 } else if (innerTypeDefinition instanceof BitsTypeDefinition) {
614 final BitsTypeDefinition bitsTypeDefinition = (BitsTypeDefinition) innerTypeDefinition;
615 final GeneratedTOBuilder genTOBuilder = provideGeneratedTOBuilderForBitsTypeDefinition(
616 basePackageName, bitsTypeDefinition, typedefName);
617 returnType = genTOBuilder.toInstance();
620 final Type javaType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(
621 innerTypeDefinition, typedef);
623 returnType = wrapJavaTypeIntoTO(basePackageName, typedef, javaType);
625 if (returnType != null) {
626 final Map<String, Type> typeMap = genTypeDefsContextMap.get(moduleName);
627 if (typeMap != null) {
628 typeMap.put(typedefName, returnType);
638 * Wraps base YANG type to generated TO.
640 * @param basePackageName
641 * string with name of package to which the module belongs
643 * type definition which is converted to the TO
645 * JAVA <code>Type</code> to which is <code>typedef</code> mapped
646 * @return generated transfer object which represent<code>javaType</code>
648 private GeneratedTransferObject wrapJavaTypeIntoTO(final String basePackageName, final TypeDefinition<?> typedef,
649 final Type javaType) {
650 if (javaType != null) {
651 final String propertyName = "value";
653 final GeneratedTOBuilder genTOBuilder = typedefToTransferObject(basePackageName, typedef);
654 final GeneratedPropertyBuilder genPropBuilder = genTOBuilder.addProperty(propertyName);
655 genPropBuilder.setReturnType(javaType);
656 genTOBuilder.addEqualsIdentity(genPropBuilder);
657 genTOBuilder.addHashIdentity(genPropBuilder);
658 genTOBuilder.addToStringProperty(genPropBuilder);
659 if (javaType == BaseYangTypes.STRING_TYPE && typedef instanceof ExtendedType) {
660 final List<String> regExps = resolveRegExpressionsFromTypedef((ExtendedType) typedef);
661 addStringRegExAsConstant(genTOBuilder, regExps);
663 return genTOBuilder.toInstance();
669 * Converts output list of generated TO builders to one TO builder (first
670 * from list) which contains the remaining builders as its enclosing TO.
672 * @param basePackageName
673 * string with name of package to which the module belongs
675 * type definition which should be of type
676 * <code>UnionTypeDefinition</code>
678 * string with name for generated TO
679 * @return generated TO builder with the list of enclosed generated TO
682 public GeneratedTOBuilder provideGeneratedTOBuilderForUnionTypeDef(final String basePackageName,
683 final UnionTypeDefinition typedef, String typeDefName, SchemaNode parentNode) {
684 final List<GeneratedTOBuilder> genTOBuilders = provideGeneratedTOBuildersForUnionTypeDef(basePackageName,
685 typedef, typeDefName, parentNode);
686 GeneratedTOBuilder resultTOBuilder = null;
687 if (!genTOBuilders.isEmpty()) {
688 resultTOBuilder = genTOBuilders.get(0);
689 genTOBuilders.remove(0);
690 for (GeneratedTOBuilder genTOBuilder : genTOBuilders) {
691 resultTOBuilder.addEnclosingTransferObject(genTOBuilder);
694 return resultTOBuilder;
698 * Converts <code>typedef</code> to generated TO with
699 * <code>typeDefName</code>. Every union type from <code>typedef</code> is
700 * added to generated TO builder as property.
702 * @param basePackageName
703 * string with name of package to which the module belongs
705 * type definition which should be of type
706 * <code>UnionTypeDefinition</code>
708 * string with name for generated TO
709 * @return generated TO builder which represents <code>typedef</code>
710 * @throws IllegalArgumentException
712 * <li>if <code>basePackageName</code> equals null</li>
713 * <li>if <code>typedef</code> equals null</li>
714 * <li>if Q name of <code>typedef</code> equals null</li>
717 public List<GeneratedTOBuilder> provideGeneratedTOBuildersForUnionTypeDef(final String basePackageName,
718 final UnionTypeDefinition typedef, final String typeDefName, final SchemaNode parentNode) {
719 Preconditions.checkArgument(basePackageName != null, "Base Package Name cannot be NULL!");
720 Preconditions.checkArgument(typedef != null, "Type Definition cannot be NULL!");
721 Preconditions.checkArgument(typedef.getQName() != null,
722 "Type Definition cannot have non specified QName (QName cannot be NULL!)");
724 final List<GeneratedTOBuilder> generatedTOBuilders = new ArrayList<>();
726 if (typedef != null) {
727 final List<TypeDefinition<?>> unionTypes = typedef.getTypes();
729 final GeneratedTOBuilder unionGenTOBuilder;
730 if (typeDefName != null && !typeDefName.isEmpty()) {
731 final String typeName = parseToClassName(typeDefName);
732 unionGenTOBuilder = new GeneratedTOBuilderImpl(basePackageName, typeName);
734 unionGenTOBuilder = typedefToTransferObject(basePackageName, typedef);
736 generatedTOBuilders.add(unionGenTOBuilder);
737 unionGenTOBuilder.setIsUnion(true);
738 final List<String> regularExpressions = new ArrayList<String>();
739 for (final TypeDefinition<?> unionType : unionTypes) {
740 final String unionTypeName = unionType.getQName().getLocalName();
741 if (unionType instanceof UnionType) {
742 generatedTOBuilders.addAll(resolveUnionSubtypeAsUnion(unionGenTOBuilder, (UnionType) unionType,
743 basePackageName, parentNode));
744 } else if (unionType instanceof ExtendedType) {
745 resolveExtendedSubtypeAsUnion(unionGenTOBuilder, (ExtendedType) unionType, unionTypeName,
746 regularExpressions, parentNode);
747 } else if (unionType instanceof EnumTypeDefinition) {
748 final Enumeration enumeration = addInnerEnumerationToTypeBuilder((EnumTypeDefinition) unionType,
749 unionTypeName, unionGenTOBuilder);
750 updateUnionTypeAsProperty(unionGenTOBuilder, enumeration, unionTypeName);
752 final Type javaType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(
753 unionType, parentNode);
754 updateUnionTypeAsProperty(unionGenTOBuilder, javaType, unionTypeName);
757 if (!regularExpressions.isEmpty()) {
758 addStringRegExAsConstant(unionGenTOBuilder, regularExpressions);
761 storeGenTO(typedef, unionGenTOBuilder, parentNode);
763 return generatedTOBuilders;
767 * Wraps code which handle case when union subtype is also of the type
768 * <code>UnionType</code>.
770 * In this case the new generated TO is created for union subtype (recursive
772 * {@link #provideGeneratedTOBuilderForUnionTypeDef(String, TypeDefinition, String)
773 * provideGeneratedTOBuilderForUnionTypeDef} and in parent TO builder
774 * <code>parentUnionGenTOBuilder</code> is created property which type is
775 * equal to new generated TO.
777 * @param parentUnionGenTOBuilder
778 * generated TO builder to which is the property with the child
779 * union subtype added
780 * @param basePackageName
781 * string with the name of the module package
782 * @param unionSubtype
783 * type definition which represents union subtype
784 * @return list of generated TO builders. The number of the builders can be
785 * bigger one due to recursive call of
786 * <code>provideGeneratedTOBuildersForUnionTypeDef</code> method.
788 private List<GeneratedTOBuilder> resolveUnionSubtypeAsUnion(final GeneratedTOBuilder parentUnionGenTOBuilder,
789 final UnionTypeDefinition unionSubtype, final String basePackageName, final SchemaNode parentNode) {
790 final String newTOBuilderName = provideAvailableNameForGenTOBuilder(parentUnionGenTOBuilder.getName());
791 final List<GeneratedTOBuilder> subUnionGenTOBUilders = provideGeneratedTOBuildersForUnionTypeDef(
792 basePackageName, unionSubtype, newTOBuilderName, parentNode);
794 final GeneratedPropertyBuilder propertyBuilder;
795 propertyBuilder = parentUnionGenTOBuilder.addProperty(BindingGeneratorUtil
796 .parseToValidParamName(newTOBuilderName));
797 propertyBuilder.setReturnType(subUnionGenTOBUilders.get(0));
798 parentUnionGenTOBuilder.addEqualsIdentity(propertyBuilder);
799 parentUnionGenTOBuilder.addToStringProperty(propertyBuilder);
801 return subUnionGenTOBUilders;
805 * Wraps code which handle case when union subtype is of the type
806 * <code>ExtendedType</code>.
808 * If TO for this type already exists it is used for the creation of the
809 * property in <code>parentUnionGenTOBuilder</code>. In other case the base
810 * type is used for the property creation.
812 * @param parentUnionGenTOBuilder
813 * generated TO builder in which new property is created
814 * @param unionSubtype
815 * type definition of the <code>ExtendedType</code> type which
816 * represents union subtype
817 * @param unionTypeName
818 * string with the name for <code>unionSubtype</code>
819 * @param regularExpressions
820 * list of strings with the regular expressions
822 private void resolveExtendedSubtypeAsUnion(final GeneratedTOBuilder parentUnionGenTOBuilder,
823 final ExtendedType unionSubtype, final String unionTypeName, final List<String> regularExpressions,
824 final SchemaNode parentNode) {
825 final Type genTO = findGenTO(unionTypeName, parentNode);
827 updateUnionTypeAsProperty(parentUnionGenTOBuilder, genTO, genTO.getName());
829 final TypeDefinition<?> baseType = baseTypeDefForExtendedType(unionSubtype);
830 if (unionTypeName.equals(baseType.getQName().getLocalName())) {
831 final Type javaType = BaseYangTypes.BASE_YANG_TYPES_PROVIDER.javaTypeForSchemaDefinitionType(baseType,
833 if (javaType != null) {
834 updateUnionTypeAsProperty(parentUnionGenTOBuilder, javaType, unionTypeName);
837 if (baseType instanceof StringType) {
838 regularExpressions.addAll(resolveRegExpressionsFromTypedef(unionSubtype));
844 * Searches for generated TO for <code>searchedTypeDef</code> type
845 * definition in {@link #genTypeDefsContextMap genTypeDefsContextMap}
847 * @param searchedTypeName
848 * string with name of <code>searchedTypeDef</code>
849 * @return generated TO for <code>searchedTypeDef</code> or
850 * <code>null</code> it it doesn't exist
852 private Type findGenTO(final String searchedTypeName, final SchemaNode parentNode) {
853 final Module typeModule = findParentModule(schemaContext, parentNode);
854 if (typeModule != null && typeModule.getName() != null) {
855 final Map<String, Type> genTOs = genTypeDefsContextMap.get(typeModule.getName());
856 if (genTOs != null) {
857 return genTOs.get(searchedTypeName);
864 * Stores generated TO created from <code>genTOBuilder</code> for
865 * <code>newTypeDef</code> to {@link #genTypeDefsContextMap
866 * genTypeDefsContextMap} if the module for <code>newTypeDef</code> exists
869 * type definition for which is <code>genTOBuilder</code> created
870 * @param genTOBuilder
871 * generated TO builder which is converted to generated TO and
874 private void storeGenTO(TypeDefinition<?> newTypeDef, GeneratedTOBuilder genTOBuilder, SchemaNode parentNode) {
875 if (!(newTypeDef instanceof UnionType)) {
876 Map<String, Type> genTOsMap = null;
877 final Module parentModule = findParentModule(schemaContext, parentNode);
878 if (parentModule != null && parentModule.getName() != null) {
879 genTOsMap = genTypeDefsContextMap.get(parentModule.getName());
880 genTOsMap.put(newTypeDef.getQName().getLocalName(), genTOBuilder.toInstance());
886 * Adds a new property with the name <code>propertyName</code> and with type
887 * <code>type</code> to <code>unonGenTransObject</code>.
889 * @param unionGenTransObject
890 * generated TO to which should be property added
892 * JAVA <code>type</code> of the property which should be added
893 * to <code>unionGentransObject</code>
894 * @param propertyName
895 * string with name of property which should be added to
896 * <code>unionGentransObject</code>
898 private void updateUnionTypeAsProperty(final GeneratedTOBuilder unionGenTransObject, final Type type,
899 final String propertyName) {
900 if (unionGenTransObject != null && type != null && !unionGenTransObject.containsProperty(propertyName)) {
901 final GeneratedPropertyBuilder propBuilder = unionGenTransObject
902 .addProperty(parseToValidParamName(propertyName));
903 propBuilder.setReturnType(type);
905 unionGenTransObject.addEqualsIdentity(propBuilder);
906 unionGenTransObject.addHashIdentity(propBuilder);
907 unionGenTransObject.addToStringProperty(propBuilder);
912 * Converts <code>typedef</code> to the generated TO builder.
914 * @param basePackageName
915 * string with name of package to which the module belongs
917 * type definition from which is the generated TO builder created
918 * @return generated TO builder which contains data from
919 * <code>typedef</code> and <code>basePackageName</code>
921 private GeneratedTOBuilder typedefToTransferObject(final String basePackageName, final TypeDefinition<?> typedef) {
923 final String packageName = packageNameForGeneratedType(basePackageName, typedef.getPath());
924 final String typeDefTOName = typedef.getQName().getLocalName();
926 if ((packageName != null) && (typedef != null) && (typeDefTOName != null)) {
927 final String genTOName = parseToClassName(typeDefTOName);
928 final GeneratedTOBuilder newType = new GeneratedTOBuilderImpl(packageName, genTOName);
929 newType.addComment(typedef.getDescription());
936 * Converts <code>typeDef</code> which should be of the type
937 * <code>BitsTypeDefinition</code> to <code>GeneratedTOBuilder</code>.
939 * All the bits of the typeDef are added to returning generated TO as
942 * @param basePackageName
943 * string with name of package to which the module belongs
945 * type definition from which is the generated TO builder created
947 * string with the name for generated TO builder
948 * @return generated TO builder which represents <code>typeDef</code>
949 * @throws IllegalArgumentException
951 * <li>if <code>typeDef</code> equals null</li>
952 * <li>if <code>basePackageName</code> equals null</li>
955 public GeneratedTOBuilder provideGeneratedTOBuilderForBitsTypeDefinition(final String basePackageName,
956 final TypeDefinition<?> typeDef, String typeDefName) {
958 Preconditions.checkArgument(typeDef != null, "typeDef cannot be NULL!");
959 Preconditions.checkArgument(basePackageName != null, "Base Package Name cannot be NULL!");
961 if (typeDef instanceof BitsTypeDefinition) {
962 BitsTypeDefinition bitsTypeDefinition = (BitsTypeDefinition) typeDef;
964 final String typeName = parseToClassName(typeDefName);
965 final GeneratedTOBuilder genTOBuilder = new GeneratedTOBuilderImpl(basePackageName, typeName);
967 final List<Bit> bitList = bitsTypeDefinition.getBits();
968 GeneratedPropertyBuilder genPropertyBuilder;
969 for (final Bit bit : bitList) {
970 String name = bit.getName();
971 genPropertyBuilder = genTOBuilder.addProperty(parseToValidParamName(name));
972 genPropertyBuilder.setReadOnly(true);
973 genPropertyBuilder.setReturnType(BaseYangTypes.BOOLEAN_TYPE);
975 genTOBuilder.addEqualsIdentity(genPropertyBuilder);
976 genTOBuilder.addHashIdentity(genPropertyBuilder);
977 genTOBuilder.addToStringProperty(genPropertyBuilder);
986 * Converts the pattern constraints from <code>typedef</code> to the list of
987 * the strings which represents these constraints.
990 * extended type in which are the pattern constraints sought
991 * @return list of strings which represents the constraint patterns
992 * @throws IllegalArgumentException
993 * if <code>typedef</code> equals null
996 private List<String> resolveRegExpressionsFromTypedef(ExtendedType typedef) {
997 final List<String> regExps = new ArrayList<String>();
998 Preconditions.checkArgument(typedef != null, "typedef can't be null");
999 final TypeDefinition<?> strTypeDef = baseTypeDefForExtendedType(typedef);
1000 if (strTypeDef instanceof StringType) {
1001 final List<PatternConstraint> patternConstraints = typedef.getPatternConstraints();
1002 if (!patternConstraints.isEmpty()) {
1004 String modifiedRegEx;
1005 for (PatternConstraint patternConstraint : patternConstraints) {
1006 regEx = patternConstraint.getRegularExpression();
1007 modifiedRegEx = StringEscapeUtils.escapeJava(regEx);
1008 regExps.add(modifiedRegEx);
1017 * Adds to the <code>genTOBuilder</code> the constant which contains regular
1018 * expressions from the <code>regularExpressions</code>
1020 * @param genTOBuilder
1021 * generated TO builder to which are
1022 * <code>regular expressions</code> added
1023 * @param regularExpressions
1024 * list of string which represent regular expressions
1025 * @throws IllegalArgumentException
1027 * <li>if <code>genTOBuilder</code> equals null</li>
1028 * <li>if <code>regularExpressions</code> equals null</li>
1031 private void addStringRegExAsConstant(GeneratedTOBuilder genTOBuilder, List<String> regularExpressions) {
1032 if (genTOBuilder == null) {
1033 throw new IllegalArgumentException("Generated transfer object builder can't be null");
1035 if (regularExpressions == null) {
1036 throw new IllegalArgumentException("List of regular expressions can't be null");
1038 if (!regularExpressions.isEmpty()) {
1039 genTOBuilder.addConstant(Types.listTypeFor(BaseYangTypes.STRING_TYPE), TypeConstants.PATTERN_CONSTANT_NAME,
1040 regularExpressions);
1045 * Creates generated TO with data about inner extended type
1046 * <code>innerExtendedType</code>, about the package name
1047 * <code>typedefName</code> and about the generated TO name
1048 * <code>typedefName</code>.
1050 * It is supposed that <code>innerExtendedType</code> is already present in
1051 * {@link TypeProviderImpl#genTypeDefsContextMap genTypeDefsContextMap} to
1052 * be possible set it as extended type for the returning generated TO.
1054 * @param innerExtendedType
1055 * extended type which is part of some other extended type
1056 * @param basePackageName
1057 * string with the package name of the module
1058 * @param typedefName
1059 * string with the name for the generated TO
1060 * @return generated TO which extends generated TO for
1061 * <code>innerExtendedType</code>
1062 * @throws IllegalArgumentException
1064 * <li>if <code>extendedType</code> equals null</li>
1065 * <li>if <code>basePackageName</code> equals null</li>
1066 * <li>if <code>typedefName</code> equals null</li>
1069 private GeneratedTransferObject provideGeneratedTOFromExtendedType(final ExtendedType innerExtendedType,
1070 final String basePackageName, final String typedefName) {
1072 Preconditions.checkArgument(innerExtendedType != null, "Extended type cannot be NULL!");
1073 Preconditions.checkArgument(basePackageName != null, "String with base package name cannot be NULL!");
1074 Preconditions.checkArgument(typedefName != null, "String with type definition name cannot be NULL!");
1076 final String classTypedefName = parseToClassName(typedefName);
1077 final String innerTypeDef = innerExtendedType.getQName().getLocalName();
1078 final GeneratedTOBuilder genTOBuilder = new GeneratedTOBuilderImpl(basePackageName, classTypedefName);
1080 Map<String, Type> typeMap = null;
1081 final Module parentModule = findParentModule(schemaContext, innerExtendedType);
1082 if (parentModule != null) {
1083 typeMap = genTypeDefsContextMap.get(parentModule.getName());
1086 if (typeMap != null) {
1087 Type type = typeMap.get(innerTypeDef);
1088 if (type instanceof GeneratedTransferObject) {
1089 genTOBuilder.setExtendsType((GeneratedTransferObject) type);
1093 return genTOBuilder.toInstance();
1097 * Finds out for each type definition how many immersion (depth) is
1098 * necessary to get to the base type. Every type definition is inserted to
1099 * the map which key is depth and value is list of type definitions with
1100 * equal depth. In next step are lists from this map concatenated to one
1101 * list in ascending order according to their depth. All type definitions
1102 * are in the list behind all type definitions on which depends.
1104 * @param unsortedTypeDefinitions
1105 * list of type definitions which should be sorted by depth
1106 * @return list of type definitions sorted according their each other
1107 * dependencies (type definitions which are depend on other type
1108 * definitions are in list behind them).
1110 private List<TypeDefinition<?>> sortTypeDefinitionAccordingDepth(
1111 final Set<TypeDefinition<?>> unsortedTypeDefinitions) {
1112 List<TypeDefinition<?>> sortedTypeDefinition = new ArrayList<>();
1114 Map<Integer, List<TypeDefinition<?>>> typeDefinitionsDepths = new TreeMap<>();
1115 for (TypeDefinition<?> unsortedTypeDefinition : unsortedTypeDefinitions) {
1116 final int depth = getTypeDefinitionDepth(unsortedTypeDefinition);
1117 List<TypeDefinition<?>> typeDefinitionsConcreteDepth = typeDefinitionsDepths.get(depth);
1118 if (typeDefinitionsConcreteDepth == null) {
1119 typeDefinitionsConcreteDepth = new ArrayList<TypeDefinition<?>>();
1120 typeDefinitionsDepths.put(depth, typeDefinitionsConcreteDepth);
1122 typeDefinitionsConcreteDepth.add(unsortedTypeDefinition);
1124 // keys are in ascending order
1125 Set<Integer> depths = typeDefinitionsDepths.keySet();
1126 for (Integer depth : depths) {
1127 sortedTypeDefinition.addAll(typeDefinitionsDepths.get(depth));
1130 return sortedTypeDefinition;
1134 * Returns how many immersion is necessary to get from the type definition
1137 * @param typeDefinition
1138 * type definition for which is depth sought.
1139 * @return number of immersions which are necessary to get from the type
1140 * definition to the base type
1142 private int getTypeDefinitionDepth(final TypeDefinition<?> typeDefinition) {
1143 if (typeDefinition == null) {
1147 TypeDefinition<?> baseType = typeDefinition.getBaseType();
1149 if (baseType instanceof ExtendedType) {
1150 depth = depth + getTypeDefinitionDepth(typeDefinition.getBaseType());
1151 } else if (baseType instanceof UnionType) {
1152 List<TypeDefinition<?>> childTypeDefinitions = ((UnionType) baseType).getTypes();
1153 int maxChildDepth = 0;
1155 for (TypeDefinition<?> childTypeDefinition : childTypeDefinitions) {
1156 childDepth = childDepth + getTypeDefinitionDepth(childTypeDefinition.getBaseType());
1157 if (childDepth > maxChildDepth) {
1158 maxChildDepth = childDepth;
1161 return maxChildDepth;
1167 * Returns string which contains the same value as <code>name</code> but
1168 * integer suffix is incremented by one. If <code>name</code> contains no
1169 * number suffix then number 1 is added.
1172 * string with name of augmented node
1173 * @return string with the number suffix incremented by one (or 1 is added)
1175 private String provideAvailableNameForGenTOBuilder(String name) {
1176 Pattern searchedPattern = Pattern.compile("[0-9]+\\z");
1177 Matcher mtch = searchedPattern.matcher(name);
1179 final int newSuffix = Integer.valueOf(name.substring(mtch.start())) + 1;
1180 return name.substring(0, mtch.start()) + newSuffix;