yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/spi/meta/AbstractDeclaredStatement.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.yangtools.yang.parser.spi.meta;
  10
  11 import com.google.common.base.Predicates;
  12 import com.google.common.collect.Collections2;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.Iterables;
  15 import java.util.Collection;
  16 import javax.annotation.Nonnull;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  19 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  20
  21 /**
  22  * Utility abstract base class for implementing declared statements.
  23  *
  24  *
  25  * @param <A> Argument type.
  26  */
  27 public abstract class AbstractDeclaredStatement<A> implements DeclaredStatement<A> {
  28     private final A argument;
  29     private final String rawArgument;
  30     private final ImmutableList<? extends DeclaredStatement<?>> substatements;
  31     private final StatementDefinition definition;
  32     private final StatementSource source;
  33
  34     protected AbstractDeclaredStatement(final StmtContext<A,?,?> context) {
  35         rawArgument = context.rawStatementArgument();
  36         argument = context.getStatementArgument();
  37         source = context.getStatementSource();
  38         definition = context.getPublicDefinition();
  39         /*
  40          * Perform an explicit copy, because Collections2.transform() is lazily transformed and retains pointer to
  41          * original collection, which may contains references to mutable context.
  42          */
  43         substatements = ImmutableList.copyOf(Collections2.transform(context.declaredSubstatements(),
  44             StmtContext::buildDeclared));
  45     }
  46
  47     protected final <S extends DeclaredStatement<?>> S firstDeclared(final Class<S> type) {
  48         return type.cast(Iterables.find(substatements, Predicates.instanceOf(type)));
  49     }
  50
  51     @Override
  52     public String rawArgument() {
  53         return rawArgument;
  54     }
  55
  56     @Override
  57     public A argument() {
  58         return argument;
  59     }
  60
  61     @Nonnull
  62     @Override
  63     public StatementDefinition statementDefinition() {
  64         return definition;
  65     }
  66
  67     @Nonnull
  68     @Override
  69     public Collection<? extends DeclaredStatement<?>> declaredSubstatements() {
  70         return substatements;
  71     }
  72
  73     @Nonnull
  74     @Override
  75     public StatementSource getStatementSource() {
  76         return source;
  77     }
  78
  79     @SuppressWarnings("unchecked")
  80     protected final <S extends DeclaredStatement<?>> Collection<? extends S> allDeclared(final Class<S> type) {
  81         return Collection.class.cast(Collections2.filter(substatements, Predicates.instanceOf(type)));
  82     }
  83 }