binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/GroupingGenerator.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.generator.impl.reactor;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import java.util.List;
  13 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultGroupingRuntimeType;
  14 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  15 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  16 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  17 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  18 import org.opendaylight.mdsal.binding.runtime.api.AugmentRuntimeType;
  19 import org.opendaylight.mdsal.binding.runtime.api.GroupingRuntimeType;
  20 import org.opendaylight.mdsal.binding.runtime.api.RuntimeType;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  23
  24 /**
  25  * Generator corresponding to a {@code grouping} statement.
  26  */
  27 final class GroupingGenerator extends AbstractCompositeGenerator<GroupingEffectiveStatement, GroupingRuntimeType> {
  28     GroupingGenerator(final GroupingEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  29         super(statement, parent);
  30     }
  31
  32     @Override
  33     StatementNamespace namespace() {
  34         return StatementNamespace.GROUPING;
  35     }
  36
  37     @Override
  38     void pushToInference(final SchemaInferenceStack dataTree) {
  39         dataTree.enterGrouping(statement().argument());
  40     }
  41
  42     @Override
  43     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  44         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  45         builder.addImplementsType(BindingTypes.DATA_OBJECT);
  46         narrowImplementedInterface(builder);
  47         addUsesInterfaces(builder, builderFactory);
  48         addGetterMethods(builder, builderFactory);
  49
  50         final ModuleGenerator module = currentModule();
  51         module.addQNameConstant(builder, statement().argument());
  52
  53         annotateDeprecatedIfNecessary(builder);
  54         builderFactory.addCodegenInformation(module, statement(), builder);
  55
  56         return builder.build();
  57     }
  58
  59     @Override
  60     void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
  61         // groupings are a separate concept
  62     }
  63
  64     @Override
  65     CompositeRuntimeTypeBuilder<GroupingEffectiveStatement, GroupingRuntimeType> createBuilder(
  66             final GroupingEffectiveStatement statement) {
  67         return new CompositeRuntimeTypeBuilder<>(statement) {
  68             @Override
  69             GroupingRuntimeType build(final GeneratedType type, final GroupingEffectiveStatement statement,
  70                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
  71                 // Groupings cannot be targeted by 'augment'
  72                 verify(augments.isEmpty(), "Unexpected augments %s", augments);
  73                 return new DefaultGroupingRuntimeType(type, statement, children);
  74             }
  75         };
  76     }
  77
  78 }