binding/mdsal-binding-generator/src/main/java/org/opendaylight/mdsal/binding/generator/impl/reactor/KeyGenerator.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 import static java.util.Objects.requireNonNull;
  12
  13 import org.opendaylight.mdsal.binding.generator.impl.reactor.CollisionDomain.Member;
  14 import org.opendaylight.mdsal.binding.generator.impl.rt.DefaultKeyRuntimeType;
  15 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  16 import org.opendaylight.mdsal.binding.model.api.Type;
  17 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase;
  18 import org.opendaylight.mdsal.binding.model.ri.BindingTypes;
  19 import org.opendaylight.mdsal.binding.runtime.api.KeyRuntimeType;
  20 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  24
  25 final class KeyGenerator extends AbstractExplicitGenerator<KeyEffectiveStatement, KeyRuntimeType> {
  26     private final ListGenerator listGen;
  27
  28     KeyGenerator(final KeyEffectiveStatement statement, final AbstractCompositeGenerator<?, ?> parent,
  29             final ListGenerator listGen) {
  30         super(statement, parent);
  31         this.listGen = requireNonNull(listGen);
  32     }
  33
  34     @Override
  35     StatementNamespace namespace() {
  36         return StatementNamespace.KEY;
  37     }
  38
  39     @Override
  40     void pushToInference(final SchemaInferenceStack inferenceStack) {
  41         throw new UnsupportedOperationException();
  42     }
  43
  44     @Override
  45     Member createMember(final CollisionDomain domain) {
  46         return domain.addSecondary(this, listGen.getMember(), Naming.KEY_SUFFIX);
  47     }
  48
  49     @Override
  50     GeneratedTransferObject createTypeImpl(final TypeBuilderFactory builderFactory) {
  51         final var builder = builderFactory.newGeneratedTOBuilder(typeName());
  52
  53         builder.addImplementsType(BindingTypes.identifier(Type.of(listGen.typeName())));
  54
  55         final var leafNames = statement().argument();
  56         for (var listChild : listGen) {
  57             if (listChild instanceof LeafGenerator leafGen) {
  58                 final QName qname = leafGen.statement().argument();
  59                 if (leafNames.contains(qname)) {
  60                     final var prop = builder
  61                         .addProperty(Naming.getPropertyName(qname.getLocalName()))
  62                         .setReturnType(leafGen.methodReturnType(builderFactory))
  63                         .setReadOnly(true);
  64
  65 //                    addComment(propBuilder, leaf);
  66
  67                     builder.addEqualsIdentity(prop);
  68                     builder.addHashIdentity(prop);
  69                     builder.addToStringProperty(prop);
  70                 }
  71             }
  72         }
  73
  74         // serialVersionUID
  75         addSerialVersionUID(builder);
  76
  77         return builder.build();
  78     }
  79
  80     @Override
  81     KeyRuntimeType createExternalRuntimeType(final Type type) {
  82         verify(type instanceof GeneratedTransferObject, "Unexpected type %s", type);
  83         return new DefaultKeyRuntimeType((GeneratedTransferObject) type, statement());
  84     }
  85
  86     @Override
  87     KeyRuntimeType createInternalRuntimeType(final AugmentResolver resolver, final KeyEffectiveStatement statement,
  88             final Type type) {
  89         // The only reference to this runtime type is from ListGenerator which is always referencing the external type
  90         throw new UnsupportedOperationException("Should never be called");
  91     }
  92
  93     @Override
  94     void addAsGetterMethod(final GeneratedTypeBuilderBase<?> builder, final TypeBuilderFactory builderFactory) {
  95         // Keys are explicitly handled by their corresponding list
  96     }
  97 }