73301fa1bb97e072b3399089656b3e52c26d090c
[mdsal.git] / binding / mdsal-binding-runtime-api / src / main / java / org / opendaylight / mdsal / binding / runtime / api / ModuleRuntimeType.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.runtime.api;
9
10 import com.google.common.annotations.Beta;
11 import org.eclipse.jdt.annotation.Nullable;
12 import org.opendaylight.yangtools.yang.common.YangDataName;
13 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
14
15 /**
16  * A {@link RuntimeType} associated with a {@code module} statement.
17  */
18 @Beta
19 public interface ModuleRuntimeType extends CompositeRuntimeType {
20     @Override
21     ModuleEffectiveStatement statement();
22
23     /**
24      * Look up a child {@link YangDataRuntimeType} by its {@link YangDataName}.
25      *
26      * @param templateName Yang Data template name
27      * @return YangDataRuntimeType or {@code null} if not found
28      */
29     @Nullable YangDataRuntimeType yangDataChild(YangDataName templateName);
30 }