import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.base.Preconditions;
-import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMultimap;
import java.util.EnumMap;
import java.util.EventListener;
import java.util.Iterator;
+import java.util.Optional;
+import java.util.Set;
import javax.annotation.Nonnull;
-import org.opendaylight.yangtools.concepts.Identifiable;
+import org.opendaylight.yangtools.yang.common.QName;
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.ModelActionBuilder;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
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.meta.StmtContextUtils;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
+import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace.SupportedFeatures;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.ValueAddedListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
- extends NamespaceStorageSupport implements StmtContext.Mutable<A, D, E>, Identifiable<StatementIdentifier> {
-
- @SuppressWarnings({ "rawtypes", "unchecked" })
- private final class SubContextBuilder extends ContextBuilder {
- final int childId;
-
- SubContextBuilder(final int childId, final StatementDefinitionContext def,
- final StatementSourceReference sourceRef) {
- super(def, sourceRef);
- this.childId = childId;
- }
-
- @Override
- public StatementContextBase build() {
- StatementContextBase<?, ?, ?> potential = substatements.get(childId);
- if (potential == null) {
- potential = new SubstatementContext(StatementContextBase.this, this);
- substatements = substatements.put(childId, potential);
- getDefinition().onStatementAdded(potential);
- }
- potential.resetLists();
- switch (this.getStamementSource().getStatementSource()) {
- case DECLARATION:
- addDeclaredSubstatement(potential);
- break;
- case CONTEXT:
- addEffectiveSubstatement(potential);
- break;
- }
- return potential;
- }
- }
-
+ extends NamespaceStorageSupport implements StmtContext.Mutable<A, D, E> {
/**
- * event listener when an item is added to model namespace
+ * event listener when an item is added to model namespace.
*/
interface OnNamespaceItemAdded extends EventListener {
/**
}
/**
- * event listener when a parsing {@link ModelProcessingPhase} is completed
+ * event listener when a parsing {@link ModelProcessingPhase} is completed.
*/
interface OnPhaseFinished extends EventListener {
/**
}
/**
- * interface for all mutations within an {@link ModelActionBuilder.InferenceAction}
+ * interface for all mutations within an {@link ModelActionBuilder.InferenceAction}.
*/
interface ContextMutation {
boolean isFinished();
}
+ private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
+
private final StatementDefinitionContext<A, D, E> definition;
- private final StatementIdentifier identifier;
private final StatementSourceReference statementDeclSource;
+ private final StmtContext<?, ?, ?> originalCtx;
+ private final CopyHistory copyHistory;
+ private final String rawArgument;
private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
- private Collection<StatementContextBase<?, ?, ?>> declared = ImmutableList.of();
- private Collection<StatementContextBase<?, ?, ?>> effective = ImmutableList.of();
- private Collection<StatementContextBase<?, ?, ?>> effectOfStatement = ImmutableList.of();
+ private Collection<Mutable<?, ?, ?>> effective = ImmutableList.of();
+ private Collection<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
private StatementMap substatements = StatementMap.empty();
- private SupportedByFeatures supportedByFeatures = SupportedByFeatures.UNDEFINED;
- private CopyHistory copyHistory = CopyHistory.original();
+ private Boolean supportedByFeatures = null;
private boolean isSupportedToBuildEffective = true;
private ModelProcessingPhase completedPhase = null;
- private StatementContextBase<?, ?, ?> originalCtx;
private D declaredInstance;
private E effectiveInstance;
private int order = 0;
- StatementContextBase(@Nonnull final ContextBuilder<A, D, E> builder) {
- this.definition = builder.getDefinition();
- this.identifier = builder.createIdentifier();
- this.statementDeclSource = builder.getStamementSource();
+ StatementContextBase(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
+ final String rawArgument) {
+ this.definition = Preconditions.checkNotNull(def);
+ this.statementDeclSource = Preconditions.checkNotNull(ref);
+ this.rawArgument = def.internArgument(rawArgument);
+ this.copyHistory = CopyHistory.original();
+ this.originalCtx = null;
}
- StatementContextBase(final StatementContextBase<A, D, E> original) {
+ StatementContextBase(final StatementContextBase<A, D, E> original, final CopyType copyType) {
this.definition = Preconditions.checkNotNull(original.definition,
"Statement context definition cannot be null copying from: %s", original.getStatementSourceReference());
- this.identifier = Preconditions.checkNotNull(original.identifier,
- "Statement context identifier cannot be null copying from: %s", original.getStatementSourceReference());
this.statementDeclSource = Preconditions.checkNotNull(original.statementDeclSource,
"Statement context statementDeclSource cannot be null copying from: %s",
original.getStatementSourceReference());
+ this.rawArgument = original.rawArgument;
+ this.copyHistory = CopyHistory.of(copyType, original.getCopyHistory());
+
+ if (original.getOriginalCtx() != null) {
+ this.originalCtx = original.getOriginalCtx();
+ } else {
+ this.originalCtx = original;
+ }
}
@Override
- public Collection<StatementContextBase<?, ?, ?>> getEffectOfStatement() {
+ public Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement() {
return effectOfStatement;
}
@Override
- public void addAsEffectOfStatement(final StatementContextBase<?, ?, ?> ctx) {
+ public void addAsEffectOfStatement(final StmtContext<?, ?, ?> ctx) {
if (effectOfStatement.isEmpty()) {
effectOfStatement = new ArrayList<>(1);
}
}
@Override
- public void addAsEffectOfStatement(final Collection<StatementContextBase<?, ?, ?>> ctxs) {
+ public void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
if (ctxs.isEmpty()) {
return;
}
}
@Override
- public SupportedByFeatures getSupportedByFeatures() {
- return supportedByFeatures;
- }
+ public boolean isSupportedByFeatures() {
+ if (supportedByFeatures == null) {
+ final Set<QName> supportedFeatures = getFromNamespace(SupportedFeaturesNamespace.class,
+ SupportedFeatures.SUPPORTED_FEATURES);
+ // If the set of supported features has not been provided, all features are supported by default.
+ supportedByFeatures = supportedFeatures == null ? Boolean.TRUE
+ : StmtContextUtils.checkFeatureSupport(this, supportedFeatures);
+ }
- @Override
- public void setSupportedByFeatures(final boolean isSupported) {
- this.supportedByFeatures = isSupported ? SupportedByFeatures.SUPPORTED : SupportedByFeatures.NOT_SUPPORTED;
+ return supportedByFeatures.booleanValue();
}
@Override
}
@Override
- public void appendCopyHistory(final CopyType typeOfCopy, final CopyHistory toAppend) {
- copyHistory = copyHistory.append(typeOfCopy, toAppend);
- }
-
- @Override
- public StatementContextBase<?, ?, ?> getOriginalCtx() {
+ public StmtContext<?, ?, ?> getOriginalCtx() {
return originalCtx;
}
- @Override
- public void setOriginalCtx(final StatementContextBase<?, ?, ?> originalCtx) {
- this.originalCtx = originalCtx;
- }
-
@Override
public void setOrder(final int order) {
this.order = order;
this.completedPhase = completedPhase;
}
- /**
- * @return context of parent of statement
- */
@Override
public abstract StatementContextBase<?, ?, ?> getParentContext();
/**
* @return root context of statement
*/
+ @Nonnull
@Override
public abstract RootStatementContext<?, ?, ?> getRoot();
- /**
- * @return statement identifier
- */
- @Override
- public StatementIdentifier getIdentifier() {
- return identifier;
- }
-
/**
* @return origin of statement
*/
+ @Nonnull
@Override
public StatementSource getStatementSource() {
return statementDeclSource.getStatementSource();
/**
* @return reference of statement source
*/
+ @Nonnull
@Override
public StatementSourceReference getStatementSourceReference() {
return statementDeclSource;
}
- /**
- * @return raw statement argument string
- */
@Override
- public String rawStatementArgument() {
- return identifier.getArgument();
+ public final String rawStatementArgument() {
+ return rawArgument;
}
- private static final <T> Collection<T> maybeWrap(final Collection<T> input) {
- if (input instanceof ImmutableCollection) {
- return input;
- }
+ @Nonnull
+ @Override
+ public Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements() {
+ return substatements.values();
+ }
- return Collections.unmodifiableCollection(input);
+ @Nonnull
+ @Override
+ public Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements() {
+ return substatements.values();
}
@Override
- public Collection<StatementContextBase<?, ?, ?>> declaredSubstatements() {
- return maybeWrap(declared);
+ public Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
+ return mutableEffectiveSubstatements();
}
+ @Nonnull
@Override
- public Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements() {
- return maybeWrap(effective);
+ public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
+ if (effective instanceof ImmutableCollection) {
+ return effective;
+ }
+
+ return Collections.unmodifiableCollection(effective);
}
- public void removeStatementsFromEffectiveSubstatements(final Collection<StatementContextBase<?, ?, ?>> substatements) {
+ public void removeStatementsFromEffectiveSubstatements(final Collection<? extends StmtContext<?, ?, ?>> substatements) {
if (!effective.isEmpty()) {
effective.removeAll(substatements);
shrinkEffective();
}
}
- public void removeStatementFromEffectiveSubstatements(final StatementDefinition refineSubstatementDef) {
+ public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
if (effective.isEmpty()) {
return;
}
- final Iterator<StatementContextBase<?, ?, ?>> iterator = effective.iterator();
+ final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
while (iterator.hasNext()) {
- final StatementContextBase<?, ?, ?> next = iterator.next();
- if (next.getPublicDefinition().equals(refineSubstatementDef)) {
+ final StmtContext<?, ?, ?> next = iterator.next();
+ if (statementDef.equals(next.getPublicDefinition())) {
+ iterator.remove();
+ }
+ }
+
+ shrinkEffective();
+ }
+
+ /**
+ * Removes a statement context from the effective substatements
+ * based on its statement definition (i.e statement keyword) and raw (in String form) statement argument.
+ * The statement context is removed only if both statement definition and statement argument match with
+ * one of the effective substatements' statement definition and argument.
+ *
+ * If the statementArg parameter is null, the statement context is removed based only on its statement definition.
+ *
+ * @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,
+ final String statementArg) {
+ if (statementArg == null) {
+ removeStatementFromEffectiveSubstatements(statementDef);
+ }
+
+ if (effective.isEmpty()) {
+ return;
+ }
+
+ final Iterator<Mutable<?, ?, ?>> iterator = effective.iterator();
+ while (iterator.hasNext()) {
+ final Mutable<?, ?, ?> next = iterator.next();
+ if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
iterator.remove();
}
}
* @throws NullPointerException
* if statement parameter is null
*/
- public void addEffectiveSubstatement(final StatementContextBase<?, ?, ?> substatement) {
- Preconditions.checkNotNull(substatement, "StatementContextBase effective substatement cannot be null at: %s",
- getStatementSourceReference());
+ public void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
beforeAddEffectiveStatement(1);
effective.add(substatement);
}
* @throws NullPointerException
* if statement parameter is null
*/
- public void addEffectiveSubstatements(final Collection<StatementContextBase<?, ?, ?>> substatements) {
+ public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> substatements) {
if (substatements.isEmpty()) {
return;
}
}
/**
- * adds declared statement to collection of substatements
+ * Create a new substatement at the specified offset.
*
- * @param substatement substatement
- * @throws IllegalStateException
- * if added in effective phase
- * @throws NullPointerException
- * if statement parameter is null
+ * @param offset Substatement offset
+ * @param def definition context
+ * @param ref source reference
+ * @param argument statement argument
+ * @return A new substatement
*/
- public void addDeclaredSubstatement(final StatementContextBase<?, ?, ?> substatement) {
-
+ public final <CA, CD extends DeclaredStatement<CA>, CE extends EffectiveStatement<CA, CD>> StatementContextBase<CA, CD, CE> createSubstatement(
+ final int offset, final StatementDefinitionContext<CA, CD, CE> def, final StatementSourceReference ref,
+ final String argument) {
final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
Preconditions.checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
"Declared statement cannot be added in effective phase at: %s", getStatementSourceReference());
- if (declared.isEmpty()) {
- declared = new ArrayList<>(1);
+ final Optional<StatementContextBase<?, ?, ?>> implicitStatement = definition.beforeSubStatementCreated(this,
+ offset, def, ref, argument);
+ if(implicitStatement.isPresent()) {
+ final StatementContextBase<?, ?, ?> presentImplicitStmt = implicitStatement.get();
+ return presentImplicitStmt.createSubstatement(offset, def, ref, argument);
}
- declared.add(Preconditions.checkNotNull(substatement,
- "StatementContextBase declared substatement cannot be null at: %s", getStatementSourceReference()));
- }
- /**
- * builds a new substatement from statement definition context and statement source reference
- *
- * @param def definition context
- * @param ref source reference
- *
- * @return instance of ContextBuilder
- */
- ContextBuilder<?, ?, ?> substatementBuilder(final int childId, final StatementDefinitionContext<?, ?, ?> def,
- final StatementSourceReference ref) {
- return new SubContextBuilder(childId, def, ref);
+ final StatementContextBase<CA, CD, CE> ret = new SubstatementContext<>(this, def, ref, argument);
+ substatements = substatements.put(offset, ret);
+ def.onStatementAdded(ret);
+ return ret;
}
/**
- * @return local namespace behaviour type {@link NamespaceBehaviour}
+ * Lookup substatement by its offset in this statement.
+ *
+ * @param offset Substatement offset
+ * @return Substatement, or null if substatement does not exist.
*/
- @Override
- public StorageNodeType getStorageNodeType() {
- return StorageNodeType.STATEMENT_LOCAL;
+ final StatementContextBase<?, ?, ?> lookupSubstatement(final int offset) {
+ return substatements.get(offset);
}
- /**
- * builds {@link DeclaredStatement} for statement context
- */
@Override
public D buildDeclared() {
Preconditions.checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION
return declaredInstance;
}
- /**
- * builds {@link EffectiveStatement} for statement context
- */
@Override
public E buildEffective() {
if (effectiveInstance == null) {
}
/**
- * 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 at: %s", getStatementSourceReference());
-
- declared = ImmutableList.of();
- }
-
- /**
- * tries to execute current {@link ModelProcessingPhase} of source parsing
+ * tries to execute current {@link ModelProcessingPhase} of source parsing.
*
* @param phase
* to be executed (completed)
}
}
- for (final StatementContextBase<?, ?, ?> child : declared) {
+ for (final StatementContextBase<?, ?, ?> child : substatements.values()) {
finished &= child.tryToCompletePhase(phase);
}
- for (final StatementContextBase<?, ?, ?> child : effective) {
- finished &= child.tryToCompletePhase(phase);
+ for (final Mutable<?, ?, ?> child : effective) {
+ if (child instanceof StatementContextBase) {
+ finished &= ((StatementContextBase<?, ?, ?>) child).tryToCompletePhase(phase);
+ }
}
if (finished) {
}
/**
- * occurs on end of {@link ModelProcessingPhase} of source parsing
+ * 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
+ * when an error occurred in source parsing
*/
private void onPhaseCompleted(final ModelProcessingPhase phase) {
completedPhase = phase;
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(final Class<N> type, final K key, final V 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);
}
final OnNamespaceItemAdded listener) throws SourceException {
final Object potential = getFromNamespace(type, key);
if (potential != null) {
+ LOG.trace("Listener on {} key {} satisfied immediately", type, key);
listener.namespaceItemAdded(this, type, key, potential);
return;
}
+
final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
- if (behaviour instanceof NamespaceBehaviourWithListeners) {
- final NamespaceBehaviourWithListeners<K, V, N> casted = (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
- casted.addValueListener(new ValueAddedListener<K>(this, key) {
- @Override
- void onValueAdded(final Object key, final Object value) {
- try {
- listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
- } catch (final SourceException e) {
- throw Throwables.propagate(e);
- }
- }
- });
- }
+ Preconditions.checkArgument(behaviour instanceof NamespaceBehaviourWithListeners,
+ "Namespace {} does not support listeners", type);
+
+ final NamespaceBehaviourWithListeners<K, V, N> casted = (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
+ casted.addValueListener(new ValueAddedListener<K>(this, key) {
+ @Override
+ void onValueAdded(final Object key, final Object value) {
+ listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
+ }
+ });
}
/**
- * @see StatementSupport#getPublicView()
+ * See {@link StatementSupport#getPublicView()}.
*/
+ @Nonnull
@Override
public StatementDefinition getPublicDefinition() {
return definition().getPublicView();
}
- /**
- * @return new {@link ModelActionBuilder} for the phase
- */
@Override
public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
return getRoot().getSourceContext().newInferenceAction(phase);
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(final Class<N> namespace, final KT key,
- final StmtContext<?, ?, ?> stmt) {
+ public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
+ final KT key,final StmtContext<?, ?, ?> stmt) {
addContextToNamespace(namespace, key, stmt);
}
}
protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
- return toStringHelper.add("definition", definition).add("id", identifier);
+ return toStringHelper.add("definition", definition).add("rawArgument", rawArgument);
}
}
Code Review / yangtools.git / blobdiff