Fix StatementRepresentation javadoc
[mdsal.git] / binding / mdsal-binding-generator / src / main / java / org / opendaylight / mdsal / binding / generator / impl / tree / StatementRepresentation.java
1 /*
2  * Copyright (c) 2022 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.tree;
9
10 import org.eclipse.jdt.annotation.NonNull;
11 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
12
13 /**
14  * An object representing a view on a particular {@link EffectiveStatement}.
15  *
16  * @param <S> Statement type
17  */
18 public interface StatementRepresentation<S extends EffectiveStatement<?, ?>> {
19     /**
20      * Return the effective YANG statement being represented by this object.
21      *
22      * @return A YANG statement
23      */
24     @NonNull S statement();
25 }