Promote RuntimeType interface hierarchy
[mdsal.git] / binding / mdsal-binding-runtime-api / src / main / java / org / opendaylight / mdsal / binding / runtime / api / RuntimeType.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 org.eclipse.jdt.annotation.NonNull;
11 import org.opendaylight.mdsal.binding.model.api.Type;
12 import org.opendaylight.yangtools.concepts.Immutable;
13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
14
15 /**
16  * Base interface for all run-time type information about a particular {@link Type}.
17  */
18 public interface RuntimeType extends Immutable {
19     /**
20      * Java type associated with this run-time type.
21      *
22      * @return Java Type
23      */
24     @NonNull Type javaType();
25
26     /**
27      * Return the {@link EffectiveStatement} associated with this run-time type.
28      *
29      * @return Effective statement
30      */
31     @NonNull EffectiveStatement<?, ?> statement();
32 }