binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding/javav2/model/api/YangSourceDefinition.java

   1 /*
   2  * Copyright (c) 2018 Cisco Systems, Inc. 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.javav2.model.api;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.Collection;
  16 import java.util.List;
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
  19 import org.opendaylight.yangtools.yang.model.api.Module;
  20 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  21
  22 /**
  23  * DTO capturing the YANG source definition which lead to a {@link GeneratedType} being emitted.
  24  *
  25  * @author Robert Varga
  26  */
  27 @Beta
  28 @NonNullByDefault
  29 public abstract class YangSourceDefinition {
  30     public static final class Multiple extends YangSourceDefinition {
  31         private final List<? extends SchemaNode> nodes;
  32
  33         Multiple(final Module module, final Collection<? extends SchemaNode> nodes) {
  34             super(module);
  35             this.nodes = ImmutableList.copyOf(nodes);
  36         }
  37
  38         /**
  39          * Return the defining SchemaNodes.
  40          *
  41          * @return defining SchemaNodes, guaranteed to be non-empty
  42          */
  43         public List<? extends SchemaNode> getNodes() {
  44             return nodes;
  45         }
  46     }
  47
  48     public static final class Single extends YangSourceDefinition {
  49         private final DocumentedNode node;
  50
  51         Single(final Module module, final DocumentedNode node) {
  52             super(module);
  53             this.node = requireNonNull(node);
  54         }
  55
  56         public DocumentedNode getNode() {
  57             return node;
  58         }
  59     }
  60
  61     private final Module module;
  62
  63     private YangSourceDefinition(final Module module) {
  64         this.module = requireNonNull(module);
  65     }
  66
  67     public static YangSourceDefinition of(final Module module) {
  68         return new Single(module, module);
  69     }
  70
  71     public static YangSourceDefinition of(final Module module, final SchemaNode node) {
  72         return new Single(module, node);
  73     }
  74
  75     public static YangSourceDefinition of(final Module module, final Collection<? extends SchemaNode> nodes) {
  76         checkArgument(!nodes.isEmpty());
  77         return new Multiple(module, nodes);
  78     }
  79
  80     /**
  81      * Return the defining YANG module.
  82      *
  83      * @return Defining YANG module.
  84      */
  85     public final Module getModule() {
  86         return module;
  87     }
  88 }