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.binding.contract.StatementNamespace;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  24
  25 /**
  26  * Generator corresponding to a {@code grouping} statement.
  27  */
  28 final class GroupingGenerator extends AbstractCompositeGenerator<GroupingEffectiveStatement, GroupingRuntimeType> {
  29     GroupingGenerator(final GroupingEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent) {
  30         super(statement, parent);
  31     }
  32
  33     @Override
  34     StatementNamespace namespace() {
  35         return StatementNamespace.GROUPING;
  36     }
  37
  38     @Override
  39     void pushToInference(final SchemaInferenceStack dataTree) {
  40         dataTree.enterGrouping(statement().argument());
  41     }
  42
  43     @Override
  44     GeneratedType createTypeImpl(final TypeBuilderFactory builderFactory) {
  45         final GeneratedTypeBuilder builder = builderFactory.newGeneratedTypeBuilder(typeName());
  46         builder.addImplementsType(BindingTypes.DATA_OBJECT);
  47         narrowImplementedInterface(builder);
  48         addUsesInterfaces(builder, builderFactory);
  49         addGetterMethods(builder, builderFactory);
  50
  51         final ModuleGenerator module = currentModule();
  52         module.addQNameConstant(builder, statement().argument());
  53
  54         annotateDeprecatedIfNecessary(builder);
  55         builderFactory.addCodegenInformation(module, statement(), builder);
  56
  57         return builder.build();
  58     }
  59
  60     @Override
  61     void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
  62         // groupings are a separate concept
  63     }
  64
  65     @Override
  66     CompositeRuntimeTypeBuilder<GroupingEffectiveStatement, GroupingRuntimeType> createBuilder(
  67             final GroupingEffectiveStatement statement) {
  68         return new CompositeRuntimeTypeBuilder<>(statement) {
  69             @Override
  70             GroupingRuntimeType build(final GeneratedType type, final GroupingEffectiveStatement statement,
  71                     final List<RuntimeType> children, final List<AugmentRuntimeType> augments) {
  72                 // Groupings cannot be targeted by 'augment'
  73                 verify(augments.isEmpty(), "Unexpected augments %s", augments);
  74                 return new DefaultGroupingRuntimeType(type, statement, children);
  75             }
  76         };
  77     }
  78
  79 }