Propagate @Nonnull and @Nullable annotations
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / effective / EffectiveStatementBase.java
index fd269a1f163d67f89a47795369571e65b4231bd0..4fabc2e4f14f957d0a9038be6870d9a1d59ca05d 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  */
 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective;
 
-import java.util.Collections;
-
-import java.util.NoSuchElementException;
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;
-import com.google.common.collect.Collections2;
+import com.google.common.base.Optional;
 import com.google.common.base.Predicates;
-import com.google.common.collect.Iterables;
-import java.util.LinkedList;
-import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
-import com.google.common.collect.FluentIterable;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
+import com.google.common.collect.Collections2;
 import com.google.common.collect.ImmutableList;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
+import com.google.common.collect.Iterables;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.List;
 import java.util.Map;
-import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
-import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
-import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 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.StmtContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
+import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
 
-abstract public class EffectiveStatementBase<A, D extends DeclaredStatement<A>>
-        implements EffectiveStatement<A, D> {
-
-    private final StmtContext<A, D, ?> stmtCtx;
-    private final ImmutableList<? extends EffectiveStatement<?, ?>> substatements;
-    private final StatementSource statementSource;
-    private final StatementDefinition statementDefinition;
-    private D declaredInstance;
-
-    private final A argument;
-
-    public EffectiveStatementBase(StmtContext<A, D, ?> ctx) {
-
-        this.stmtCtx = ctx;
-        this.statementDefinition = ctx.getPublicDefinition();
-        this.argument = ctx.getStatementArgument();
-        this.statementSource = ctx.getStatementSource();
-
-        Collection<StatementContextBase<?, ?, ?>> declaredSubstatements = ctx
-                .declaredSubstatements();
-        Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements = ctx
-                .effectiveSubstatements();
-
-        Collection<StatementContextBase<?, ?, ?>> substatementsInit = new LinkedList<>();
-        substatementsInit.addAll(declaredSubstatements);
+public abstract class EffectiveStatementBase<A, D extends DeclaredStatement<A>> implements EffectiveStatement<A, D> {
+    private final List<? extends EffectiveStatement<?, ?>> substatements;
+
+    /**
+     * Constructor.
+     *
+     * @param ctx
+     *            context of statement.
+     */
+    protected EffectiveStatementBase(final StmtContext<A, D, ?> ctx) {
+        final Collection<StatementContextBase<?, ?, ?>> effectiveSubstatements = ctx.effectiveSubstatements();
+        final Collection<StatementContextBase<?, ?, ?>> substatementsInit = new ArrayList<>();
+
+        final Collection<StatementContextBase<?, ?, ?>> supportedDeclaredSubStmts = Collections2.filter(
+                ctx.declaredSubstatements(), StmtContextUtils::areFeaturesSupported);
+        for (final StatementContextBase<?, ?, ?> declaredSubstatement : supportedDeclaredSubStmts) {
+            if (declaredSubstatement.getPublicDefinition().equals(Rfc6020Mapping.USES)) {
+                substatementsInit.add(declaredSubstatement);
+                substatementsInit.addAll(declaredSubstatement.getEffectOfStatement());
+                ((StatementContextBase<?, ?, ?>) ctx).removeStatementsFromEffectiveSubstatements(declaredSubstatement
+                        .getEffectOfStatement());
+            } else {
+                substatementsInit.add(declaredSubstatement);
+            }
+        }
         substatementsInit.addAll(effectiveSubstatements);
 
-        this.substatements = FluentIterable.from(substatementsInit)
-                .transform(StmtContextUtils.buildEffective()).toList();
+        this.substatements = ImmutableList.copyOf(initSubstatements(substatementsInit));
     }
 
-    @Override
-    public StatementDefinition statementDefinition() {
-        return statementDefinition;
+    /**
+     * Create a set of substatements. This method is split out so it can be overridden in
+     * {@link ExtensionEffectiveStatementImpl} to leak a not-fully-initialized instance.
+     *
+     * @param substatementsInit proposed substatements
+     * @return Filtered substatements
+     */
+    Collection<? extends EffectiveStatement<?, ?>> initSubstatements(
+            final Collection<StatementContextBase<?, ?, ?>> substatementsInit) {
+        return Collections2.transform(Collections2.filter(substatementsInit,
+            StmtContext::isSupportedToBuildEffective), StatementContextBase::buildEffective);
     }
 
     @Override
-    public A argument() {
-        return argument;
+    public final <K, V, N extends IdentifierNamespace<K, V>> V get(@Nonnull final Class<N> namespace, @Nonnull final K identifier) {
+        throw new UnsupportedOperationException("Not implemented yet.");
     }
 
     @Override
-    public StatementSource getStatementSource() {
-        return statementSource;
+    public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAll(@Nonnull final Class<N> namespace) {
+        throw new UnsupportedOperationException("Not implemented yet.");
     }
 
+    @Nonnull
     @Override
-    public D getDeclared() {
-        if (declaredInstance == null) {
-            declaredInstance = stmtCtx.buildDeclared();
-        }
-
-        return declaredInstance;
-    }
-
-    // public <K, V, N extends IdentifierNamespace<? super K, ? extends V>> V
-    // get(
-    @Override
-    public <K, V, N extends IdentifierNamespace<K, V>> V get(
-            Class<N> namespace, K identifier) {
-        return stmtCtx.getFromNamespace(namespace, identifier);
-    }
-
-    @Override
-    public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAll(
-            Class<N> namespace) {
-        return (Map<K, V>) stmtCtx.getAllFromNamespace(namespace);
-    }
-
-    @Override
-    public Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
+    public final Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements() {
         return substatements;
     }
 
-    public StmtContext<A, D, ?> getStatementContext() {
-        return stmtCtx;
+    protected final <S extends EffectiveStatement<?, ?>> S firstEffective(final Class<S> type) {
+        final Optional<? extends EffectiveStatement<?, ?>> possible = Iterables.tryFind(substatements,
+                Predicates.instanceOf(type));
+        return possible.isPresent() ? type.cast(possible.get()) : null;
     }
 
-    protected final <S extends EffectiveStatement<?, ?>> S firstEffective(
-            Class<S> type) {
-        S result = null;
-        try {
-            result = type.cast(Iterables.find(substatements,
-                    Predicates.instanceOf(type)));
-        } catch (NoSuchElementException e) {
-            result = null;
-        }
-        return result;
+    protected final <S extends SchemaNode> S firstSchemaNode(final Class<S> type) {
+        final Optional<? extends EffectiveStatement<?, ?>> possible = Iterables.tryFind(substatements,
+                Predicates.instanceOf(type));
+        return possible.isPresent() ? type.cast(possible.get()) : null;
     }
 
     @SuppressWarnings("unchecked")
-    protected final <S extends EffectiveStatement<?, ?>> Collection<? extends S> allEffective(
-            Class<S> type) {
-        Collection<? extends S> result = null;
-
-        try {
-            result = Collection.class.cast(Collections2.filter(substatements,
-                    Predicates.instanceOf(type)));
-        } catch (NoSuchElementException e) {
-            result = Collections.emptyList();
-        }
-        return result;
+    protected final <T> Collection<T> allSubstatementsOfType(final Class<T> type) {
+        return Collection.class.cast(Collections2.filter(substatements, Predicates.instanceOf(type)));
     }
 
-    protected final <S extends SchemaNode> S firstSchemaNode(Class<S> type) {
-        S result = null;
-        try {
-            result = type.cast(Iterables.find(substatements,
-                    Predicates.instanceOf(type)));
-        } catch (NoSuchElementException e) {
-            result = null;
-        }
-        return result;
+    protected final <T> T firstSubstatementOfType(final Class<T> type) {
+        final Optional<? extends EffectiveStatement<?, ?>> possible = Iterables.tryFind(substatements,
+                Predicates.instanceOf(type));
+        return possible.isPresent() ? type.cast(possible.get()) : null;
     }
 
-    @SuppressWarnings("unchecked")
-    protected final <S extends SchemaNode> Collection<? extends S> allSchemaNodes(
-            Class<S> type) {
-        Collection<? extends S> result = null;
-
-        try {
-            result = Collection.class.cast(Collections2.filter(substatements,
-                    Predicates.instanceOf(type)));
-        } catch (NoSuchElementException e) {
-            result = Collections.emptyList();
-        }
-        return result;
+    protected final <R> R firstSubstatementOfType(final Class<?> type, final Class<R> returnType) {
+        final Optional<? extends EffectiveStatement<?, ?>> possible = Iterables.tryFind(substatements,
+                Predicates.and(Predicates.instanceOf(type), Predicates.instanceOf(returnType)));
+        return possible.isPresent() ? returnType.cast(possible.get()) : null;
     }
 
+    protected final EffectiveStatement<?, ?> firstEffectiveSubstatementOfType(final Class<?> type) {
+        return Iterables.tryFind(substatements, Predicates.instanceOf(type)).orNull();
+    }
 }