Refactor InferenceAction
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / ModifierImpl.java
index 638952cf3dc44241d0479ede263f6dc16569e693..e917f958ef65a026d840982fc7866999e79e551d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2015, 2016 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -10,11 +10,14 @@ package org.opendaylight.yangtools.yang.parser.stmt.reactor;
 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
 
-import com.google.common.base.Function;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.MoreObjects.ToStringHelper;
 import com.google.common.base.Preconditions;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.Set;
+import java.util.function.Function;
+import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
@@ -24,108 +27,97 @@ import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
-class ModifierImpl implements ModelActionBuilder {
+final class ModifierImpl implements ModelActionBuilder {
+    private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
 
-    private final ModelProcessingPhase phase;
-    private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>();
-    private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>();
+    private final InferenceContext ctx = new InferenceContext() { };
+
+    private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
+    private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
 
     private InferenceAction action;
     private boolean actionApplied = false;
 
-    ModifierImpl(ModelProcessingPhase phase) {
-        this.phase = Preconditions.checkNotNull(phase);
-    }
-
-    private <D> AbstractPrerequisite<D> addReq(AbstractPrerequisite<D> prereq) {
+    private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
+        LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
         unsatisfied.add(prereq);
         return prereq;
     }
 
-    private <T> AbstractPrerequisite<T> addMutation(AbstractPrerequisite<T> mutation) {
+    private <T> AbstractPrerequisite<T> addMutation(final AbstractPrerequisite<T> mutation) {
+        LOG.trace("Modifier {} adding mutation {}", this, mutation);
         mutations.add(mutation);
         return mutation;
     }
 
-
-
     private void checkNotRegistered() {
         Preconditions.checkState(action == null, "Action was already registered.");
     }
 
-    private IllegalStateException shouldNotHappenProbablyBug(SourceException e) {
-        return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.",e);
-    }
-
-    private void tryToResolve() throws InferenceException {
-        if(action == null) {
-            return; // Action was not yet defined
-        }
-        if(removeSatisfied()) {
-            applyAction();
-        }
+    private static IllegalStateException shouldNotHappenProbablyBug(final SourceException e) {
+        return new IllegalStateException("Source exception during registering prerequisite. This is probably bug.", e);
     }
 
     private boolean removeSatisfied() {
-        Iterator<AbstractPrerequisite<?>> prereq = unsatisfied.iterator();
-        boolean allSatisfied = true;
-        while(prereq.hasNext()) {
-            if(prereq.next().isDone()) {
-                prereq.remove(); // We are removing current prerequisite from list.
-            } else {
-                allSatisfied  = false;
+        final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
+        while (it.hasNext()) {
+            final AbstractPrerequisite<?> prereq = it.next();
+            if (prereq.isDone()) {
+                // We are removing current prerequisite from list.
+                LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
+                it.remove();
             }
         }
-        return allSatisfied;
-    }
-
-    ModelProcessingPhase getPhase() {
-        return phase;
+        return unsatisfied.isEmpty();
     }
 
     boolean isApplied() {
-
         return actionApplied;
     }
 
-    void failModifier() throws InferenceException {
+    void failModifier() {
         removeSatisfied();
         action.prerequisiteFailed(unsatisfied);
         action = null;
     }
 
-    private void applyAction() throws InferenceException {
-
-        action.apply();
-        // Mark all mutations as performed, so context node could move to next.
+    private void applyAction() {
+        Preconditions.checkState(!actionApplied);
+        action.apply(ctx);
         actionApplied = true;
     }
 
     @SuppressWarnings({ "unchecked", "rawtypes" })
-    private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(StmtContext<?, ?, ?> context, Class<N> namespace, K key,ModelProcessingPhase phase)  {
+    private <K, C extends StmtContext<?,?,?>, N extends StatementNamespace<K, ?, ?>> AbstractPrerequisite<C>
+            requiresCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key,
+                    final ModelProcessingPhase phase)  {
         checkNotRegistered();
+
         try {
-            AddedToNamespace<C> addedToNs = new AddedToNamespace<C>(phase);
+            AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
             addReq(addedToNs);
-            contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,addedToNs);
+            contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, addedToNs);
             return addedToNs;
         } catch (SourceException e) {
             throw shouldNotHappenProbablyBug(e);
         }
     }
 
-    private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(C context, ModelProcessingPhase phase) {
-        Preconditions.checkState(action == null, "Action was already registered.");
+    private <C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresCtxImpl(final C context,
+            final ModelProcessingPhase phase) {
+        checkNotRegistered();
+
         try {
-            PhaseFinished<C> phaseFin = new PhaseFinished<C>();
+            PhaseFinished<C> phaseFin = new PhaseFinished<>();
             addReq(phaseFin);
-            contextImpl(context).addPhaseCompletedListener(phase,phaseFin);
+            contextImpl(context).addPhaseCompletedListener(phase, phaseFin);
             return phaseFin;
         } catch (SourceException e) {
             throw shouldNotHappenProbablyBug(e);
@@ -133,156 +125,166 @@ class ModifierImpl implements ModelActionBuilder {
     }
 
     @SuppressWarnings({ "rawtypes", "unchecked" })
-    private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends StatementNamespace<K, ?, ? >> AbstractPrerequisite<C> mutatesCtxImpl(
-                StmtContext<?, ?, ?> context, Class<N> namespace, K key, ModelProcessingPhase phase) {
-            try {
-                PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<C>(phase);
-                addMutation(mod);
-                contextImpl(context).onNamespaceItemAddedAction((Class) namespace,key,mod);
-                return mod;
-            } catch (SourceException e) {
-                throw shouldNotHappenProbablyBug(e);
-            }
+    private <K, C extends StmtContext.Mutable<?, ?, ?> , N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>>
+            AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context, final Class<N> namespace,
+                    final K key, final ModelProcessingPhase phase) {
+        checkNotRegistered();
+
+        try {
+            PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(phase);
+            addReq(mod);
+            addMutation(mod);
+            contextImpl(context).onNamespaceItemAddedAction((Class) namespace, key, mod);
+            return mod;
+        } catch (SourceException e) {
+            throw shouldNotHappenProbablyBug(e);
         }
+    }
+
+    private static StatementContextBase<?,?,?> contextImpl(final Object value) {
+        Preconditions.checkArgument(value instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
+        return StatementContextBase.class.cast(value);
+    }
 
-    private static StatementContextBase<?,?,?> contextImpl(StmtContext<?,?,?> context) {
-        Preconditions.checkArgument(context instanceof StatementContextBase,"Supplied context was not provided by this reactor.");
-        return StatementContextBase.class.cast(context);
+    boolean tryApply() {
+        Preconditions.checkState(action != null, "Action was not defined yet.");
+
+        if (removeSatisfied()) {
+            applyAction();
+            return true;
+        }
+        return false;
     }
 
+    @Nonnull
     @Override
-    public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(CT context, ModelProcessingPhase phase) {
+    public <C extends Mutable<?, ?, ?>, CT extends C> Prerequisite<C> mutatesCtx(final CT context, final ModelProcessingPhase phase) {
         try {
-            return addMutation(new PhaseMutation<C>(contextImpl(context),phase));
+            return addMutation(new PhaseMutation<>(contextImpl(context), phase));
         } catch (InferenceException e) {
             throw shouldNotHappenProbablyBug(e);
         }
     }
 
+    @Nonnull
     @Override
-    public  <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(StmtContext<A, D, E> context, ModelProcessingPhase phase) {
+    public <A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A, D>> AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context, final ModelProcessingPhase phase) {
         return requiresCtxImpl(context, phase);
     }
 
 
+    @Nonnull
     @Override
-    public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(StmtContext<?, ?, ?> context, Class<N> namespace, K key, ModelProcessingPhase phase) {
+    public <K, N extends StatementNamespace<K, ?, ? >> Prerequisite<StmtContext<?,?,?>> requiresCtx(final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key, final ModelProcessingPhase phase) {
         return requiresCtxImpl(context, namespace, key, phase);
     }
 
+    @Nonnull
     @Override
-    public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(StmtContext<?, ? extends D, ?> context) {
-        return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContextUtils.<D>buildDeclared());
+    public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ? extends D, ?> context) {
+        return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::buildDeclared);
     }
 
+    @Nonnull
     @Override
     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
-            StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
+            final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
     }
 
+    @Nonnull
     @Override
     public <K, D extends DeclaredStatement<?>, N extends StatementNamespace<K, ? extends D, ?>> Prerequisite<D> requiresDeclared(
-            StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
-        final AbstractPrerequisite<StmtContext<?,D,?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
-        return rawContext.transform(StmtContextUtils.<D>buildDeclared());
+            final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
+        final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
+        return rawContext.transform(StmtContext::buildDeclared);
     }
 
+    @Nonnull
     @Override
-    public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(StmtContext<?, ?, ? extends E> stmt) {
-        return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContextUtils.<E>buildEffective());
+    public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ? extends E> stmt) {
+        return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
     }
 
+    @Nonnull
     @Override
     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
-            StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
-        return requiresCtxImpl(contextImpl(context),namespace,key, EFFECTIVE_MODEL);
+            final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
+        return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
     }
 
+    @Nonnull
     @Override
     public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> Prerequisite<E> requiresEffective(
-            StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
+            final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
         final AbstractPrerequisite<StmtContext<?,?,E>> rawContext = requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
-        return rawContext.transform(StmtContextUtils.<E>buildEffective());
+        return rawContext.transform(StmtContext::buildEffective);
     }
 
 
+    @Nonnull
     @Override
-    public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(Mutable<?, ?, ?> context,
-            Class<N> namespace) {
+    public <N extends IdentifierNamespace<?, ?>> Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
+            final Class<N> namespace) {
         try {
-            return addMutation(new NamespaceMutation<N>(contextImpl(context),namespace));
+            return addMutation(new NamespaceMutation<>(contextImpl(context), namespace));
         } catch (SourceException e) {
             throw shouldNotHappenProbablyBug(e);
         }
     }
 
+    @Nonnull
     @Override
-    public <T extends Mutable<?, ?, ?>> Prerequisite<T> mutatesEffectiveCtx(T stmt) {
-        return mutatesCtx(stmt, EFFECTIVE_MODEL);
-    }
-
-
-   @Override
-    public <K, E extends EffectiveStatement<?, ?>, N extends StatementNamespace<K, ?, ? extends E>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
-            StmtContext<?, ?, ?> context, Class<N> namespace, K key) {
+    public <K, E extends EffectiveStatement<?, ?>, N extends IdentifierNamespace<K, ? extends StmtContext<?, ?, ?>>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
+            final StmtContext<?, ?, ?> context, final Class<N> namespace, final K key) {
         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
     }
 
-
-
     @Override
-    public void apply(InferenceAction action) throws InferenceException {
+    public void apply(final InferenceAction action) {
+        Preconditions.checkState(this.action == null, "Action already defined to %s", this.action);
         this.action = Preconditions.checkNotNull(action);
-        tryToResolve();
     }
 
     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 
-        private T value;
         private boolean done = false;
+        private T value;
 
         @Override
-        public T get() {
-            Preconditions.checkState(isDone());
+        public final T resolve(final InferenceContext ctx) {
+            Preconditions.checkState(done);
+            Preconditions.checkArgument(ctx == ModifierImpl.this.ctx);
             return value;
         }
 
-        @Override
-        public boolean isDone() {
+        final boolean isDone() {
             return done;
         }
 
-        protected void resolvePrereq(T value) throws InferenceException {
-            Preconditions.checkState(!isDone());
+        final boolean resolvePrereq(final T value) {
             this.value = value;
             this.done = true;
-            tryToResolve();
+            return isApplied();
         }
 
-        protected <O> Prerequisite<O> transform(final Function<? super T,O> transformation) {
-
-            return new Prerequisite<O>() {
-
-                @Override
-                public O get() {
-                    return transformation.apply(AbstractPrerequisite.this.get());
-                }
-
-                @Override
-                public boolean isDone() {
-                    return AbstractPrerequisite.this.isDone();
-                }
+        final <O> Prerequisite<O> transform(final Function<? super T, O> transformation) {
+            return ctx -> transformation.apply(resolve(ctx));
+        }
 
-            };
+        @Override
+        public final String toString() {
+            return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
         }
 
+        ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
+            return toStringHelper.add("value", value);
+        }
     }
 
     private class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
-
         @SuppressWarnings("unchecked")
-        public PhaseMutation(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws InferenceException {
+        public PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
             context.addMutation(phase, this);
             resolvePrereq((C) context);
         }
@@ -291,64 +293,63 @@ class ModifierImpl implements ModelActionBuilder {
         public boolean isFinished() {
             return isApplied();
         }
-
-
     }
-    private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
 
+    private class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C> implements OnPhaseFinished {
         @SuppressWarnings("unchecked")
         @Override
-        public void phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws SourceException {
-            resolvePrereq((C) (context));
+        public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
+            return resolvePrereq((C) context);
         }
     }
 
-    private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends  AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>>  {
-
-        public NamespaceMutation(StatementContextBase<?, ?, ?> ctx, Class<N> namespace) throws InferenceException {
+    private class NamespaceMutation<N extends IdentifierNamespace<?,?>> extends AbstractPrerequisite<StmtContext.Mutable<?, ?, ?>>  {
+        public NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final Class<N> namespace) {
             resolvePrereq(ctx);
         }
-
     }
 
-    private class AddedToNamespace<C extends StmtContext<?,?,?>> extends  AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
-
+    private class AddedToNamespace<C extends StmtContext<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded,OnPhaseFinished {
         private final ModelProcessingPhase phase;
 
-        public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(ModelProcessingPhase phase) {
+        public <K, N extends StatementNamespace<K, ?, ?>> AddedToNamespace(final ModelProcessingPhase phase) {
             this.phase = phase;
         }
 
         @Override
-        public void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key,
-                Object value) throws SourceException {
+        public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
+                final Object value) {
             StatementContextBase<?, ?, ?> targetContext = (StatementContextBase<?, ?, ?>) value;
             targetContext.addPhaseCompletedListener(phase, this);
         }
 
         @SuppressWarnings("unchecked")
         @Override
-        public void phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws SourceException {
-            resolvePrereq((C) context);
+        public boolean phaseFinished(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
+            return resolvePrereq((C) context);
         }
 
+        @Override
+        ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
+            return super.addToStringAttributes(toStringHelper).add("phase", phase);
+        }
     }
 
     private class PhaseModificationInNamespace<C extends Mutable<?,?,?>> extends AbstractPrerequisite<C> implements OnNamespaceItemAdded, ContextMutation {
-
         private final ModelProcessingPhase modPhase;
 
-        public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(ModelProcessingPhase phase) throws SourceException {
+        public <K, N extends StatementNamespace<K, ?, ?>> PhaseModificationInNamespace(final ModelProcessingPhase phase) {
             Preconditions.checkArgument(phase != null, "Model processing phase must not be null");
             this.modPhase = phase;
         }
 
         @SuppressWarnings("unchecked")
         @Override
-        public void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key,
-                Object value) throws SourceException {
-            context.addMutation(modPhase,this);
-            resolvePrereq((C) context);
+        public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context, final Class<?> namespace, final Object key,
+                final Object value) {
+            StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
+            targetCtx.addMutation(modPhase, this);
+            resolvePrereq((C) targetCtx);
         }
 
         @Override
@@ -356,5 +357,4 @@ class ModifierImpl implements ModelActionBuilder {
             return isApplied();
         }
     }
-
 }