yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/EffectiveStatementInference.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.yangtools.yang.model.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.List;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.concepts.Immutable;
  14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  15
  16 /**
  17  * A base class of an {@link EffectiveModelContext} context reasoning with regards to what logical sequence of
  18  * {@link EffectiveStatement}s were considered. Implementations of this class may provide additional facts which were
  19  * derived from the line of reasoning.
  20  */
  21 @Beta
  22 public interface EffectiveStatementInference extends EffectiveModelContextProvider, Immutable {
  23     /**
  24      * An {@code Unmodifiable} {@link List} of {@link EffectiveStatement}s, ordered in some meaningful way. Precise
  25      * semantics of the statement order is clarified by individual {@link EffectiveStatementInference} specializations.
  26      *
  27      * @see SchemaTreeInference
  28      * @return A List of EffectiveStatements
  29      */
  30     @NonNull List<? extends @NonNull EffectiveStatement<?, ?>> statementPath();
  31 }