2 * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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.generator.impl.reactor;
10 import static com.google.common.base.Verify.verify;
11 import static java.util.Objects.requireNonNull;
13 import java.util.ArrayList;
14 import java.util.List;
15 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultTypedefRuntimeType;
16 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
17 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
18 import org.opendaylight.mdsal.binding.model.api.Type;
19 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
20 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
21 import org.opendaylight.mdsal.binding.runtime.api.TypedefRuntimeType;
22 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
23 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
27 * Generator corresponding to a {@code typedef} statement.
29 final class TypedefGenerator extends AbstractTypeObjectGenerator<TypedefEffectiveStatement, TypedefRuntimeType> {
31 * List of all generators for types directly derived from this typedef. We populate this list during initial type
32 * linking. It allows us to easily cascade inferences made by this typedef down the type derivation tree.
34 private List<AbstractTypeObjectGenerator<?, ?>> derivedGenerators = null;
36 TypedefGenerator(final TypedefEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
37 super(statement, parent);
41 StatementNamespace namespace() {
42 return StatementNamespace.TYPEDEF;
46 void pushToInference(final SchemaInferenceStack dataTree) {
47 dataTree.enterTypedef(statement().argument());
50 void addDerivedGenerator(final AbstractTypeObjectGenerator<?, ?> derivedGenerator) {
51 if (derivedGenerators == null) {
52 derivedGenerators = new ArrayList<>(4);
54 derivedGenerators.add(requireNonNull(derivedGenerator));
58 void bindDerivedGenerators(final TypeReference reference) {
59 // Trigger any derived resolvers ...
60 if (derivedGenerators != null) {
61 for (AbstractTypeObjectGenerator<?, ?> derived : derivedGenerators) {
62 derived.bindTypeDefinition(reference);
65 // ... and make sure nobody can come in late
66 derivedGenerators = List.of();
70 ClassPlacement classPlacementImpl() {
71 return ClassPlacement.TOP_LEVEL;
75 TypeDefinition<?> extractTypeDefinition() {
76 return statement().getTypeDefinition();
80 GeneratedTransferObject createDerivedType(final TypeBuilderFactory builderFactory,
81 final GeneratedTransferObject baseType) {
82 final GeneratedTOBuilder builder = builderFactory.newGeneratedTOBuilder(typeName());
83 builder.setTypedef(true);
84 builder.setExtendsType(baseType);
85 builder.setIsUnion(baseType.isUnionType());
86 builder.setRestrictions(computeRestrictions());
88 final TypeDefinition<?> typedef = statement().getTypeDefinition();
89 annotateDeprecatedIfNecessary(typedef, builder);
90 addStringRegExAsConstant(builder, resolveRegExpressions(typedef));
91 addUnits(builder, typedef);
93 makeSerializable(builder);
94 return builder.build();
98 TypedefRuntimeType createExternalRuntimeType(final Type type) {
99 verify(type instanceof GeneratedType, "Unexpected type %s", type);
100 return new DefaultTypedefRuntimeType((GeneratedType) type, statement());
104 TypedefRuntimeType createInternalRuntimeType(final AugmentResolver resolver,
105 final TypedefEffectiveStatement statement, final Type type) {
106 // 'typedef' statements are not schema tree statements, they should not have internal references
107 throw new UnsupportedOperationException("Should never be called");
111 void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
112 // typedefs are a separate concept