2 * Copyright (c) 2022 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.runtime.api;
10 import com.google.common.annotations.Beta;
11 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
14 * Marker interface for concrete {@link RuntimeType}s relevant when dealing data hierarchy. This interface does not have
15 * a direct relationship with the {@code data tree} YANG construct, nor with {@code YangInstanceIdentifier} addressing.
16 * Its primary role is differentiating between various types when considered in the context of
17 * {@link RuntimeTypeContainer}'s child methods and related inferences. In particular, {@link DataRuntimeType}s are
18 * relevant when considering whether or not a particular RuntimeType child is part of the data encoding (according to
19 * the Binding Specification) to the {@code schema tree} layout.
22 * DataRuntimeTypes are considered part of the {@code data tree} information encoded by the Binding Specification and
23 * thus need to be considered as child nodes when considering other data-bearing construct, such as
24 * {@code NormalizedNode}. That relationship may not be straightforward, but notably it excludes constructs like
25 * {@link NotificationRuntimeType}, {@link IdentityRuntimeType}, {@link ActionRuntimeType}, {@link GroupingRuntimeType},
26 * and similar, as those exist in outside of {@code data tree} contract, but are still part of what
27 * {@link RuntimeTypeContainer#bindingChild(JavaTypeName)} considers as child constructs.
30 public interface DataRuntimeType extends RuntimeType {
31 // Marker interface, no further contract is specified