parser/yang-parser-spi/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/StatementFactory.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.parser.spi.meta;
   9
  10 import java.util.Collection;
  11 import java.util.stream.Stream;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  15 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  16
  17 /**
  18  * An entity capable of creating {@link DeclaredStatement} and {@link EffectiveStatement} instances for a particular
  19  * type. This interface is usually realized as an implementation-specific combination with {@link StatementSupport}.
  20  *
  21  * @param <A> Argument type
  22  * @param <D> Declared Statement representation
  23  * @param <E> Effective Statement representation
  24  */
  25 public interface StatementFactory<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
  26     /**
  27      * Create a {@link DeclaredStatement} for specified context.
  28      *
  29      * @param ctx Statement context
  30      * @return A declared statement instance.
  31      */
  32     @NonNull D createDeclared(@NonNull StmtContext<A, D, ?> ctx);
  33
  34     /**
  35      * Create a {@link EffectiveStatement} for specified context.
  36      *
  37      * @param stmt Effective capture of this statement's significant state
  38      * @param declaredSubstatements effectively-visible declared substatements
  39      * @param inferredSubstatements effectively-visible inferred substatements
  40      * @return An effective statement instance
  41      */
  42     // FIXME: we really want a single coherent 'effectiveSubstatements' stream
  43     @NonNull E createEffective(@NonNull Current<A, D> stmt,
  44         Stream<? extends StmtContext<?, ?, ?>> declaredSubstatements,
  45         Stream<? extends StmtContext<?, ?, ?>> inferredSubstatements);
  46
  47     /**
  48      * Create a {@link EffectiveStatement} copy of provided original for specified context.
  49      *
  50      * @param stmt Effective capture of this statement's significant state
  51      * @param original Original effective statement
  52      * @return An effective statement instance
  53      * @throws NullPointerException if any argument is null
  54      */
  55     @NonNull E copyEffective(@NonNull Current<A, D> stmt, @NonNull E original);
  56
  57     /**
  58      * Determine reactor copy behaviour of a statement instance. Implementations classes are required to determine
  59      * their operations with regard to their statements being replicated into different contexts -- potentially sharing
  60      * instantiations.
  61      *
  62      * <p>
  63      * Implementations are examine {@code copy} as to whether it would result in the same semantics as {@code current}
  64      * does, provided that {@code current}'s {@code substatements} are properly propagated.
  65      *
  66      * @param copy Copy of current effective context
  67      * @param current Current effective context
  68      * @param substatements Current effective substatements
  69      * @return True if the differences between {@code copy} and {@code current} do not affect this statement's effective
  70      *         semantics.
  71      * @throws NullPointerException if any argument is null
  72      */
  73     boolean canReuseCurrent(@NonNull Current<A, D> copy, @NonNull Current<A, D> current,
  74         @NonNull Collection<? extends EffectiveStatement<?, ?>> substatements);
  75 }