import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
-import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ConfigEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
- private List<Mutable<?, ?, ?>> effective = ImmutableList.of();
+
private List<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
private @Nullable ModelProcessingPhase completedPhase;
*/
@Override
public final <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(
- final Class<N> type, final T key, final U value) {
+ final Class<@NonNull N> type, final T key, final U value) {
addToNamespace(type, key, value);
}
* @throws NamespaceNotAvailableException when the namespace is not available.
*/
@Override
- public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(final Class<N> type,
- final T key) {
+ public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(
+ final Class<@NonNull N> type, final T key) {
return getBehaviourRegistry().getNamespaceBehaviour(type).getFrom(this, key);
}
- @Override
- public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
- if (effective instanceof ImmutableCollection) {
- return effective;
- }
-
- return Collections.unmodifiableCollection(effective);
+ static final Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements(
+ final List<StatementContextBase<?, ?, ?>> effective) {
+ return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective);
}
- private void shrinkEffective() {
- if (effective.isEmpty()) {
- effective = ImmutableList.of();
- }
+ private static List<StatementContextBase<?, ?, ?>> shrinkEffective(
+ final List<StatementContextBase<?, ?, ?>> effective) {
+ return effective.isEmpty() ? ImmutableList.of() : effective;
}
- public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
+ public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef);
+
+ static final List<StatementContextBase<?, ?, ?>> removeStatementFromEffectiveSubstatements(
+ final List<StatementContextBase<?, ?, ?>> effective, final StatementDefinition statementDef) {
if (effective.isEmpty()) {
- return;
+ return effective;
}
final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
}
}
- shrinkEffective();
+ return shrinkEffective(effective);
}
/**
* @param statementDef statement definition of the statement context to remove
* @param statementArg statement argument of the statement context to remove
*/
- public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef,
+ public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef,
+ String statementArg);
+
+ static final List<StatementContextBase<?, ?, ?>> removeStatementFromEffectiveSubstatements(
+ final List<StatementContextBase<?, ?, ?>> effective, final StatementDefinition statementDef,
final String statementArg) {
if (statementArg == null) {
- removeStatementFromEffectiveSubstatements(statementDef);
+ return removeStatementFromEffectiveSubstatements(effective, statementDef);
}
if (effective.isEmpty()) {
- return;
+ return effective;
}
- final Iterator<Mutable<?, ?, ?>> iterator = effective.iterator();
+ final Iterator<StatementContextBase<?, ?, ?>> iterator = effective.iterator();
while (iterator.hasNext()) {
final Mutable<?, ?, ?> next = iterator.next();
if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
}
}
- shrinkEffective();
+ return shrinkEffective(effective);
}
// YANG example: RPC/action statements always have 'input' and 'output' defined
* Adds an effective statement to collection of substatements.
*
* @param substatement substatement
- * @throws IllegalStateException
- * if added in declared phase
- * @throws NullPointerException
- * if statement parameter is null
+ * @throws IllegalStateException if added in declared phase
+ * @throws NullPointerException if statement parameter is null
*/
- public void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
- beforeAddEffectiveStatement(1);
- effective.add(substatement);
+ public abstract void addEffectiveSubstatement(Mutable<?, ?, ?> substatement);
+
+ final List<StatementContextBase<?, ?, ?>> addEffectiveSubstatement(
+ final List<StatementContextBase<?, ?, ?>> effective, final Mutable<?, ?, ?> substatement) {
+ verifyStatement(substatement);
+
+ final List<StatementContextBase<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, 1);
+ final StatementContextBase<?, ?, ?> stmt = (StatementContextBase<?, ?, ?>) substatement;
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ ensureCompletedPhase(stmt, phase);
+ }
+ resized.add(stmt);
+ return resized;
}
/**
* @throws NullPointerException
* if statement parameter is null
*/
- public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
- if (statements.isEmpty()) {
- return;
+ public final void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
+ if (!statements.isEmpty()) {
+ statements.forEach(StatementContextBase::verifyStatement);
+ addEffectiveSubstatementsImpl(statements);
}
+ }
+
+ abstract void addEffectiveSubstatementsImpl(Collection<? extends Mutable<?, ?, ?>> statements);
+
+ final List<StatementContextBase<?, ?, ?>> addEffectiveSubstatementsImpl(
+ final List<StatementContextBase<?, ?, ?>> effective,
+ final Collection<? extends Mutable<?, ?, ?>> statements) {
+ final List<StatementContextBase<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, statements.size());
+ final Collection<? extends StatementContextBase<?, ?, ?>> casted =
+ (Collection<? extends StatementContextBase<?, ?, ?>>) statements;
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ for (StatementContextBase<?, ?, ?> stmt : casted) {
+ ensureCompletedPhase(stmt, phase);
+ }
+ }
+
+ resized.addAll(casted);
+ return resized;
+ }
+
+ abstract Iterable<StatementContextBase<?, ?, ?>> effectiveChildrenToComplete();
+
+ // exposed for InferredStatementContext only
+ final void ensureCompletedPhase(final Mutable<?, ?, ?> stmt) {
+ verifyStatement(stmt);
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ ensureCompletedPhase((StatementContextBase<?, ?, ?>) stmt, phase);
+ }
+ }
- statements.forEach(Objects::requireNonNull);
- beforeAddEffectiveStatement(statements.size());
- effective.addAll(statements);
+ // Make sure target statement has transitioned at least to specified phase. This method is just before we take
+ // allow a statement to become our substatement. This is needed to ensure that every statement tree does not contain
+ // any statements which did not complete the same phase as the root statement.
+ private static void ensureCompletedPhase(final StatementContextBase<?, ?, ?> stmt,
+ final ModelProcessingPhase phase) {
+ verify(stmt.tryToCompletePhase(phase), "Statement %s cannot complete phase %s", stmt, phase);
}
- private void beforeAddEffectiveStatement(final int toAdd) {
+ private static void verifyStatement(final Mutable<?, ?, ?> stmt) {
+ verify(stmt instanceof StatementContextBase, "Unexpected statement %s", stmt);
+ }
+
+ private List<StatementContextBase<?, ?, ?>> beforeAddEffectiveStatement(
+ final List<StatementContextBase<?, ?, ?>> effective, final int toAdd) {
+ // We cannot allow statement to be further mutated
+ verify(completedPhase != ModelProcessingPhase.EFFECTIVE_MODEL, "Cannot modify finished statement at %s",
+ getStatementSourceReference());
+ return beforeAddEffectiveStatementUnsafe(effective, toAdd);
+ }
+
+ final List<StatementContextBase<?, ?, ?>> beforeAddEffectiveStatementUnsafe(
+ final List<StatementContextBase<?, ?, ?>> effective, final int toAdd) {
final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
|| inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
"Effective statement cannot be added in declared phase at: %s", getStatementSourceReference());
- if (effective.isEmpty()) {
- effective = new ArrayList<>(toAdd);
- }
+ return effective.isEmpty() ? new ArrayList<>(toAdd) : effective;
}
- // Exists only due to memory optimization
+ // These two exists only due to memory optimization, should live in AbstractResumedStatement
final boolean fullyDefined() {
return fullyDefined;
}
- // Exists only due to memory optimization, should live in AbstractResumedStatement
final void setFullyDefined() {
fullyDefined = true;
}
@Override
public E buildEffective() {
- final E existing = effectiveInstance;
- return existing != null ? existing : (effectiveInstance = definition.getFactory().createEffective(this));
+ final E existing;
+ return (existing = effectiveInstance) != null ? existing : loadEffective();
+ }
+
+ private E loadEffective() {
+ return effectiveInstance = definition.getFactory().createEffective(this);
}
/**
- * tries to execute current {@link ModelProcessingPhase} of source parsing.
+ * Try to execute current {@link ModelProcessingPhase} of source parsing. If the phase has already been executed,
+ * this method does nothing.
*
- * @param phase
- * to be executed (completed)
- * @return if phase was successfully completed
- * @throws SourceException
- * when an error occurred in source parsing
+ * @param phase to be executed (completed)
+ * @return true if phase was successfully completed
+ * @throws SourceException when an error occurred in source parsing
*/
- boolean tryToCompletePhase(final ModelProcessingPhase phase) {
-
- boolean finished = true;
- final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
- if (!openMutations.isEmpty()) {
- final Iterator<ContextMutation> it = openMutations.iterator();
- while (it.hasNext()) {
- final ContextMutation current = it.next();
- if (current.isFinished()) {
- it.remove();
- } else {
- finished = false;
- }
- }
+ final boolean tryToCompletePhase(final ModelProcessingPhase phase) {
+ return phase.isCompletedBy(completedPhase) || doTryToCompletePhase(phase);
+ }
- if (openMutations.isEmpty()) {
- phaseMutation.removeAll(phase);
- if (phaseMutation.isEmpty()) {
- phaseMutation = ImmutableMultimap.of();
- }
- }
+ private boolean doTryToCompletePhase(final ModelProcessingPhase phase) {
+ final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase);
+ if (completeChildren(phase) && finished) {
+ onPhaseCompleted(phase);
+ return true;
}
+ return false;
+ }
+ private boolean completeChildren(final ModelProcessingPhase phase) {
+ boolean finished = true;
for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
finished &= child.tryToCompletePhase(phase);
}
- for (final Mutable<?, ?, ?> child : effective) {
- if (child instanceof StatementContextBase) {
- finished &= ((StatementContextBase<?, ?, ?>) child).tryToCompletePhase(phase);
+ for (final StatementContextBase<?, ?, ?> child : effectiveChildrenToComplete()) {
+ finished &= child.tryToCompletePhase(phase);
+ }
+ return finished;
+ }
+
+ private boolean runMutations(final ModelProcessingPhase phase) {
+ final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
+ return openMutations.isEmpty() ? true : runMutations(phase, openMutations);
+ }
+
+ private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
+ boolean finished = true;
+ final Iterator<ContextMutation> it = openMutations.iterator();
+ while (it.hasNext()) {
+ final ContextMutation current = it.next();
+ if (current.isFinished()) {
+ it.remove();
+ } else {
+ finished = false;
}
}
- if (finished) {
- onPhaseCompleted(phase);
- return true;
+ if (openMutations.isEmpty()) {
+ phaseMutation.removeAll(phase);
+ cleanupPhaseMutation();
+ }
+ return finished;
+ }
+
+ private void cleanupPhaseMutation() {
+ if (phaseMutation.isEmpty()) {
+ phaseMutation = ImmutableMultimap.of();
}
- return false;
}
/**
completedPhase = phase;
final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
- if (listeners.isEmpty()) {
- return;
+ if (!listeners.isEmpty()) {
+ runPhaseListeners(phase, listeners);
}
+ }
+ private void runPhaseListeners(final ModelProcessingPhase phase, final Collection<OnPhaseFinished> listeners) {
final Iterator<OnPhaseFinished> listener = listeners.iterator();
while (listener.hasNext()) {
final OnPhaseFinished next = listener.next();
/**
* Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
*
- * @throws IllegalStateException
- * when the mutation was registered after phase was completed
+ * @throws IllegalStateException when the mutation was registered after phase was completed
*/
- void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
+ final void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
ModelProcessingPhase finishedPhase = completedPhase;
while (finishedPhase != null) {
checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s",
phaseMutation.put(phase, mutation);
}
+ final void removeMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
+ if (!phaseMutation.isEmpty()) {
+ phaseMutation.remove(phase, mutation);
+ cleanupPhaseMutation();
+ }
+ }
+
@Override
- public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
+ public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<@NonNull N> namespace,
final KT key,final StmtContext<?, ?, ?> stmt) {
addContextToNamespace(namespace, key, stmt);
}
final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule);
switch (policy) {
case CONTEXT_INDEPENDENT:
- // FIXME: YANGTOOLS-652: we need isEmpty() here for performance reasons
- if (allSubstatementsStream().findAny().isEmpty()) {
+ if (hasEmptySubstatements()) {
// This statement is context-independent and has no substatements -- hence it can be freely shared.
return Optional.of(this);
}
return Optional.of(parent.childCopyOf(this, type, targetModule));
case IGNORE:
return Optional.empty();
+ case REJECT:
+ throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
default:
throw new IllegalStateException("Unhandled policy " + policy);
}
abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
+ /**
+ * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
+ *
+ * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
+ */
+ abstract boolean hasEmptySubstatements();
+
/**
* Config statements are not all that common which means we are performing a recursive search towards the root
* every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
return true;
}
- final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
- ConfigStatement.class);
final boolean isConfig;
- if (configStatement != null) {
- isConfig = configStatement.coerceStatementArgument();
+ final Optional<Boolean> optConfig = findSubstatementArgument(ConfigEffectiveStatement.class);
+ if (optConfig.isPresent()) {
+ isConfig = optConfig.orElseThrow();
if (isConfig) {
// Validity check: if parent is config=false this cannot be a config=true
InferenceException.throwIf(!parent.isConfiguration(), getStatementSourceReference(),
return false;
}
- // Exists only to support SubstatementContext/InferredStatementContext
+ // Exists only to support {SubstatementContext,InferredStatementContext}.getSchemaPath()
+ @Deprecated
final @NonNull Optional<SchemaPath> substatementGetSchemaPath() {
SchemaPath local = schemaPath;
if (local == null) {
synchronized (this) {
local = schemaPath;
if (local == null) {
- local = createSchemaPath(coerceParentContext());
- schemaPath = local;
+ schemaPath = local = createSchemaPath(coerceParentContext());
}
}
}
return Optional.ofNullable(local);
}
+ @Deprecated
private SchemaPath createSchemaPath(final Mutable<?, ?, ?> parent) {
final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
final Object argument = getStatementArgument();
if (argument instanceof QName) {
final QName qname = (QName) argument;
- if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
+ if (producesDeclared(UsesStatement.class)) {
return maybeParentPath.orElse(null);
}
return parentPath.createChild(qname);
}
if (argument instanceof SchemaNodeIdentifier
- && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
- || StmtContextUtils.producesDeclared(this, RefineStatement.class)
- || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
+ && (producesDeclared(AugmentStatement.class) || producesDeclared(RefineStatement.class)
+ || producesDeclared(DeviationStatement.class))) {
- return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
+ return parentPath.createChild(((SchemaNodeIdentifier) argument).getNodeIdentifiers());
}
// FIXME: this does not look right
Code Review / yangtools.git / blobdiff