import java.util.EventListener;
import java.util.Iterator;
import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.concepts.Identifiable;
+import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
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;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.ValueAddedListener;
-public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
- NamespaceStorageSupport implements StmtContext.Mutable<A, D, E>, Identifiable<StatementIdentifier> {
+public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
+
extends NamespaceStorageSupport implements StmtContext.Mutable<A, D, E>, Identifiable<StatementIdentifier> {
- interface OnNamespaceItemAdded extends EventListener{
+ /**
+ * event listener when an item is added to model namespace
+ */
+ interface OnNamespaceItemAdded extends EventListener {
- void namespaceItemAdded(StatementContextBase<?,?,?> context, Class<?> namespace, Object key, Object value) throws SourceException;
+ void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key, Object value)
+ throws SourceException;
}
- interface OnPhaseFinished extends EventListener{
+ /**
+ * event listener when a parsing {@link ModelProcessingPhase} is completed
+ */
+ interface OnPhaseFinished extends EventListener {
- void phaseFinished(StatementContextBase<?,?,?> context, ModelProcessingPhase phase) throws SourceException;
+ boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase phase) throws SourceException;
}
+ /**
+ * interface for all mutations within an {@link ModelActionBuilder.InferenceAction}
+ */
interface ContextMutation {
boolean isFinished();
}
- abstract static class ContextBuilder<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> {
+ private final StatementDefinitionContext<A, D, E> definition;
+ private final StatementIdentifier identifier;
+ private final StatementSourceReference statementDeclSource;
+ private int order = 0;
- private final StatementDefinitionContext<A, D, E> definition;
- private final StatementSourceReference stmtRef;
- private String rawArg;
- private StatementSourceReference argRef;
+ private final Map<StatementIdentifier, StatementContextBase<?, ?, ?>> substatements = new LinkedHashMap<>();
- public ContextBuilder(StatementDefinitionContext<A, D, E> def, StatementSourceReference sourceRef) {
- this.definition = def;
- this.stmtRef = sourceRef;
- }
+ private final Collection<StatementContextBase<?, ?, ?>> declared = new ArrayList<>();
+ private final Collection<StatementContextBase<?, ?, ?>> effective = new ArrayList<>();
+ private final Collection<StatementContextBase<?, ?, ?>> effectOfStatement = new ArrayList<>();
- public void setArgument(@Nonnull String argument, @Nonnull StatementSourceReference argumentSource) {
- Preconditions.checkArgument(definition.hasArgument(), "Statement does not take argument.");
- this.rawArg = Preconditions.checkNotNull(argument);
- this.argRef = Preconditions.checkNotNull(argumentSource);
- }
+ @Override
+ public Collection<StatementContextBase<?, ?, ?>> getEffectOfStatement() {
+ return effectOfStatement;
+ }
- public String getRawArgument() {
- return rawArg;
- }
+ @Override
+ public void addAsEffectOfStatement(final StatementContextBase<?, ?, ?> ctx) {
+ effectOfStatement.add(ctx);
+ }
- public StatementSourceReference getStamementSource() {
- return stmtRef;
- }
+ private ModelProcessingPhase completedPhase;
- public StatementSourceReference getArgumentSource() {
- return argRef;
- }
+ private final Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = HashMultimap.create();
+ private final Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = HashMultimap.create();
- public StatementDefinitionContext<A, D, E> getDefinition() {
- return definition;
- }
+ private D declaredInstance;
+ private E effectiveInstance;
- public StatementIdentifier getIdentifier() {
- return new StatementIdentifier(definition.getStatementName(), rawArg);
- }
+ private StatementContextBase<?, ?, ?> originalCtx;
+ private final List<TypeOfCopy> copyHistory = new ArrayList<>(1);
- public abstract StatementContextBase<A, D, E> build() throws SourceException;
+ private boolean isSupportedToBuildEffective = true;
+ @Override
+ public boolean isSupportedToBuildEffective() {
+ return isSupportedToBuildEffective;
}
- private final StatementDefinitionContext<A, D, E> definition;
- private final StatementIdentifier identifier;
- private final StatementSourceReference statementDeclSource;
+ @Override
+ public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) {
+ this.isSupportedToBuildEffective = isSupportedToBuildEffective;
+ }
- private LinkedHashMap<StatementIdentifier, StatementContextBase<?, ?, ?> > substatements = new LinkedHashMap<>();
+ @Override
+ public List<TypeOfCopy> getCopyHistory() {
+ return copyHistory;
+ }
- private Collection<StatementContextBase<?, ?, ?>> declared = new ArrayList<>();
- private Collection<StatementContextBase<?, ?, ?>> effective = new ArrayList<>();
+ @Override
+ public void addToCopyHistory(final TypeOfCopy typeOfCopy) {
+ this.copyHistory.add(typeOfCopy);
+ }
- private ModelProcessingPhase completedPhase;
+ @Override
+ public void addAllToCopyHistory(final List<TypeOfCopy> typeOfCopyList) {
+ this.copyHistory.addAll(typeOfCopyList);
+ }
- private Multimap<ModelProcessingPhase,OnPhaseFinished> phaseListeners = HashMultimap.create();
- private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = HashMultimap.create();
+ @Override
+ public StatementContextBase<?, ?, ?> getOriginalCtx() {
+ return originalCtx;
+ }
- private D declaredInstance;
- private E effectiveInstance;
+ @Override
+ public void setOriginalCtx(final StatementContextBase<?, ?, ?> originalCtx) {
+ this.originalCtx = originalCtx;
+ }
+
+ @Override
+ public void setOrder(final int order) {
+ this.order = order;
+ }
+ @Override
+ public int getOrder() {
+ return order;
+ }
- StatementContextBase(@Nonnull ContextBuilder<A, D, E> builder) throws SourceException {
+ @Override
+ public ModelProcessingPhase getCompletedPhase() {
+ return completedPhase;
+ }
+
+ @Override
+ public void setCompletedPhase(final ModelProcessingPhase completedPhase) {
+ this.completedPhase = completedPhase;
+ }
+
+ StatementContextBase(@Nonnull final ContextBuilder<A, D, E> builder) throws SourceException {
this.definition = builder.getDefinition();
- this.identifier = builder.getIdentifier();
+ this.identifier = builder.createIdentifier();
this.statementDeclSource = builder.getStamementSource();
this.completedPhase = null;
+ this.copyHistory.add(TypeOfCopy.ORIGINAL);
}
- StatementContextBase(StatementContextBase<A,D,E> original) {
- this.definition = original.definition;
- this.identifier = original.identifier;
- this.statementDeclSource = original.statementDeclSource;
+ StatementContextBase(final StatementContextBase<A, D, E> original) {
+ this.definition = Preconditions
+ .checkNotNull(original.definition, "Statement context definition cannot be null");
+ this.identifier = Preconditions
+ .checkNotNull(original.identifier, "Statement context identifier cannot be null");
+ this.statementDeclSource = Preconditions.checkNotNull(original.statementDeclSource,
+ "Statement context statementDeclSource cannot be null");
this.completedPhase = null;
+ this.copyHistory.add(TypeOfCopy.ORIGINAL);
}
+ /**
+ * @return context of parent of statement
+ */
@Override
public abstract StatementContextBase<?, ?, ?> getParentContext();
+ /**
+ * @return root context of statement
+ */
@Override
public abstract RootStatementContext<?, ?, ?> getRoot();
-
+ /**
+ * @return statement identifier
+ */
@Override
public StatementIdentifier getIdentifier() {
return identifier;
}
+ /**
+ * @return origin of statement
+ */
@Override
public StatementSource getStatementSource() {
return statementDeclSource.getStatementSource();
}
+ /**
+ * @return reference of statement source
+ */
@Override
public StatementSourceReference getStatementSourceReference() {
return statementDeclSource;
}
+ /**
+ * @return raw statement argument string
+ */
@Override
public String rawStatementArgument() {
return identifier.getArgument();
}
+ /**
+ * @return collection of declared substatements
+ */
@Override
public Collection<StatementContextBase<?, ?, ?>> declaredSubstatements() {
return Collections.unmodifiableCollection(declared);
}
+ /**
+ * @return collection of substatements
+ */
+ @Override
+ public Collection<StatementContextBase<?, ?, ?>> substatements() {
+ return Collections.unmodifiableCollection(substatements.values());
+ }
+
+ /**
+ * @return collection of effective substatements
+ */
@Override
public Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements() {
return Collections.unmodifiableCollection(effective);
}
- public void addEffectiveSubstatement(StatementContextBase<?, ?, ?> substatement){
- effective.add(substatement);
+ public void removeStatementsFromEffectiveSubstatements(final Collection<StatementContextBase<?, ?, ?>> substatements) {
+ effective.removeAll(substatements);
}
- public void addDeclaredSubstatement(StatementContextBase<?, ?, ?> substatement){
- declared.add(substatement);
+ public void removeStatementFromEffectiveSubstatements(final StatementDefinition refineSubstatementDef) {
+ Iterator<StatementContextBase<?, ?, ?>> iterator = effective.iterator();
+ while (iterator.hasNext()) {
+ StatementContextBase<?, ?, ?> next = iterator.next();
+ if (next.getPublicDefinition().equals(refineSubstatementDef)) {
+ iterator.remove();
+ }
+ }
+ }
+
+ /**
+ * adds effective statement to collection of substatements
+ *
+ * @throws IllegalStateException
+ * if added in declared phase
+ * @throws NullPointerException
+ * if statement parameter is null
+ *
+ * @param substatement substatement
+ */
+ public void addEffectiveSubstatement(final StatementContextBase<?, ?, ?> substatement) {
+
+ final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
+ Preconditions.checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
+ || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Effective statement cannot be added in declared phase");
+
+ effective.add(Preconditions.checkNotNull(substatement,
+ "StatementContextBase effective substatement cannot be null"));
}
+ /**
+ * adds declared statement to collection of substatements
+ *
+ * @throws IllegalStateException
+ * if added in effective phase
+ * @throws NullPointerException
+ * if statement parameter is null
+ *
+ * @param substatement substatement
+ */
+ public void addDeclaredSubstatement(final StatementContextBase<?, ?, ?> substatement) {
+
+ final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
+ Preconditions.checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Declared statement cannot be added in effective phase");
+
+ declared.add(Preconditions.checkNotNull(substatement,
+ "StatementContextBase declared substatement cannot be null"));
+ }
+
+ /**
+ * builds new substatement from statement definition context and statement source reference
+ *
+ * @param def definition context
+ * @param ref source reference
+ *
+ * @return instance of ContextBuilder
+ */
@SuppressWarnings({ "rawtypes", "unchecked" })
- public ContextBuilder<?, ?, ?> substatementBuilder(StatementDefinitionContext<?, ?, ?> def,
- StatementSourceReference ref) {
+ public ContextBuilder<?, ?, ?> substatementBuilder(final StatementDefinitionContext<?, ?, ?> def,
+ final StatementSourceReference ref) {
return new ContextBuilder(def, ref) {
@Override
public StatementContextBase build() throws SourceException {
- StatementContextBase<?, ?, ?> potential = substatements.get(getIdentifier());
- if(potential == null) {
+ StatementContextBase<?, ?, ?> potential = null;
+
+ StatementDefinition stmtDef = getDefinition().getPublicView();
+ if (stmtDef != Rfc6020Mapping.AUGMENT && stmtDef != Rfc6020Mapping.DEVIATION) {
+ potential = substatements.get(createIdentifier());
+ }
+ if (potential == null) {
potential = new SubstatementContext(StatementContextBase.this, this);
- substatements.put(getIdentifier(), potential);
+ substatements.put(createIdentifier(), potential);
+ getDefinition().onStatementAdded(potential);
}
potential.resetLists();
switch (this.getStamementSource().getStatementSource()) {
- case DECLARATION:
- declared.add(potential);
- break;
- case CONTEXT:
- effective.add(potential);
- break;
+ case DECLARATION:
+ addDeclaredSubstatement(potential);
+ break;
+ case CONTEXT:
+ addEffectiveSubstatement(potential);
+ break;
}
return potential;
}
};
}
-
-
+ /**
+ * @return local namespace behaviour type {@link NamespaceBehaviour}
+ */
@Override
public StorageNodeType getStorageNodeType() {
return StorageNodeType.STATEMENT_LOCAL;
}
+ /**
+ * builds {@link DeclaredStatement} for statement context
+ */
@Override
public D buildDeclared() {
- Preconditions.checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
+ Preconditions.checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION
+ || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
if (declaredInstance == null) {
declaredInstance = definition().getFactory().createDeclared(this);
}
return declaredInstance;
}
+ /**
+ * builds {@link EffectiveStatement} for statement context
+ */
@Override
public E buildEffective() {
- Preconditions.checkArgument(completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
if (effectiveInstance == null) {
effectiveInstance = definition().getFactory().createEffective(this);
}
return effectiveInstance;
}
-
+ /**
+ * clears collection of declared substatements
+ *
+ * @throws IllegalStateException
+ * if invoked in effective build phase
+ */
void resetLists() {
+
+ final SourceSpecificContext sourceContext = getRoot().getSourceContext();
+ Preconditions.checkState(sourceContext.getInProgressPhase() != ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Declared statements list cannot be cleared in effective phase");
+
declared.clear();
}
- boolean tryToCompletePhase(ModelProcessingPhase phase) throws SourceException {
- if(phase.equals(completedPhase)) {
- return true;
- }
+ /**
+ * tries to execute current {@link ModelProcessingPhase} of source parsing
+ *
+ * @param phase
+ * to be executed (completed)
+ * @return if phase was successfully completed
+ * @throws SourceException
+ * when an error occured in source parsing
+ */
+ boolean tryToCompletePhase(final ModelProcessingPhase phase) throws SourceException {
Iterator<ContextMutation> openMutations = phaseMutation.get(phase).iterator();
boolean finished = true;
- while(openMutations.hasNext()) {
+ while (openMutations.hasNext()) {
ContextMutation current = openMutations.next();
- if(current.isFinished()) {
+ if (current.isFinished()) {
openMutations.remove();
} else {
finished = false;
}
}
- for(StatementContextBase<?, ?, ?> child: declared) {
+ for (StatementContextBase<?, ?, ?> child : declared) {
finished &= child.tryToCompletePhase(phase);
}
- for(StatementContextBase<?, ?, ?> child: effective) {
+ for (StatementContextBase<?, ?, ?> child : effective) {
finished &= child.tryToCompletePhase(phase);
}
- if(finished) {
+
+ if (finished) {
onPhaseCompleted(phase);
return true;
}
return false;
}
-
- private void onPhaseCompleted(ModelProcessingPhase phase) throws SourceException {
+ /**
+ * occurs on end of {@link ModelProcessingPhase} of source parsing
+ *
+ * @param phase
+ * that was to be completed (finished)
+ * @throws SourceException
+ * when an error occured in source parsing
+ */
+ private void onPhaseCompleted(final ModelProcessingPhase phase) throws SourceException {
completedPhase = phase;
Iterator<OnPhaseFinished> listener = phaseListeners.get(completedPhase).iterator();
- while(listener.hasNext()) {
- listener.next().phaseFinished(this, phase);
- listener.remove();
+ while (listener.hasNext()) {
+ OnPhaseFinished next = listener.next();
+ if (next.phaseFinished(this, phase)) {
+ listener.remove();
+ }
}
}
/**
- *
* Ends declared section of current node.
*
* @param ref
* @throws SourceException
- *
*/
- void endDeclared(StatementSourceReference ref,ModelProcessingPhase phase) throws SourceException {
- definition().onDeclarationFinished(this,phase);
+ void endDeclared(final StatementSourceReference ref, final ModelProcessingPhase phase) throws SourceException {
+ definition().onDeclarationFinished(this, phase);
}
+ /**
+ * @return statement definition
+ */
protected final StatementDefinitionContext<A, D, E> definition() {
return definition;
}
@Override
- protected void checkLocalNamespaceAllowed(Class<? extends IdentifierNamespace<?, ?>> type) {
+ protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
definition().checkNamespaceAllowed(type);
}
+ /**
+ * occurs when an item is added to model namespace
+ *
+ * @throws SourceException instance of SourceException
+ */
@Override
- protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(Class<N> type, K key, V value) {
- //definition().onNamespaceElementAdded(this, type, key, value);
+ protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key, final V value) {
+ // definition().onNamespaceElementAdded(this, type, key, value);
}
- <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, K key, final OnNamespaceItemAdded listener) throws SourceException {
+ <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
+ final OnNamespaceItemAdded listener) throws SourceException {
Object potential = getFromNamespace(type, key);
- if(potential != null) {
+ if (potential != null) {
listener.namespaceItemAdded(this, type, key, potential);
return;
}
- NamespaceBehaviour<K,V,N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
- if(behaviour instanceof NamespaceBehaviourWithListeners) {
- NamespaceBehaviourWithListeners<K, V, N> casted = (NamespaceBehaviourWithListeners<K,V,N>) behaviour;
- casted.addValueListener(key, new ValueAddedListener(this) {
+ NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
+ if (behaviour instanceof NamespaceBehaviourWithListeners) {
+ NamespaceBehaviourWithListeners<K, V, N> casted = (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
+ casted.addValueListener(new ValueAddedListener<K>(this, key) {
@Override
- void onValueAdded(Object key, Object value) {
+ void onValueAdded(final Object key, final Object value) {
try {
listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
} catch (SourceException e) {
}
}
+ /**
+ * @see StatementSupport#getPublicView()
+ */
@Override
public StatementDefinition getPublicDefinition() {
return definition().getPublicView();
}
+ /**
+ * @return new {@link ModelActionBuilder} for the phase
+ */
@Override
- public ModelActionBuilder newInferenceAction(ModelProcessingPhase phase) {
+ public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
return getRoot().getSourceContext().newInferenceAction(phase);
}
- void addPhaseCompletedListener(ModelProcessingPhase phase, OnPhaseFinished listener) throws SourceException {
+ /**
+ * adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end
+ *
+ * @throws SourceException
+ */
+ void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) throws SourceException {
+
+ Preconditions.checkNotNull(phase, "Statement context processing phase cannot be null");
+ Preconditions.checkNotNull(listener, "Statement context phase listener cannot be null");
+
ModelProcessingPhase finishedPhase = completedPhase;
while (finishedPhase != null) {
- if(phase.equals(finishedPhase)) {
+ if (phase.equals(finishedPhase)) {
listener.phaseFinished(this, finishedPhase);
return;
}
phaseListeners.put(phase, listener);
}
- void addMutation(ModelProcessingPhase phase, ContextMutation mutation) {
+ /**
+ * adds {@link ContextMutation} to {@link ModelProcessingPhase}
+ *
+ * @throws IllegalStateException
+ * when the mutation was registered after phase was completed
+ */
+ void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
ModelProcessingPhase finishedPhase = completedPhase;
while (finishedPhase != null) {
- if(phase.equals(finishedPhase)) {
+ if (phase.equals(finishedPhase)) {
throw new IllegalStateException("Mutation registered after phase was completed.");
}
finishedPhase = finishedPhase.getPreviousPhase();
phaseMutation.put(phase, mutation);
}
+ /**
+ * adds statement to namespace map with the key
+ *
+ * @param namespace
+ * {@link StatementNamespace} child that determines namespace to be added to
+ * @param key
+ * of type according to namespace class specification
+ * @param stmt
+ * to be added to namespace map
+ */
@Override
- public <K,KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(
- Class<N> namepsace, KT key, StmtContext<?, ?, ?> stmt) {
- addContextToNamespace(namepsace,(K) key, stmt);
+ public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace, final KT key,
+ final StmtContext<?, ?, ?> stmt) {
+ addContextToNamespace(namespace, (K) key, stmt);
}
}
Code Review / yangtools.git / blobdiff