yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/EffectiveStatement.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 package org.opendaylight.yangtools.yang.model.api.meta;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableMap;
  14 import java.util.Collection;
  15 import java.util.Map;
  16 import java.util.Optional;
  17 import java.util.stream.Stream;
  18 import javax.annotation.Nonnull;
  19 import javax.annotation.Nullable;
  20 import org.eclipse.jdt.annotation.NonNull;
  21
  22 /**
  23  * Effective model statement which should be used to derive application behaviour.
  24  *
  25  * @param <A>
  26  *            Argument type ({@link Void} if statement does not have argument.)
  27  * @param <S>
  28  *            Class representing declared version of this statement.
  29  */
  30 public interface EffectiveStatement<A, S extends DeclaredStatement<A>> extends ModelStatement<A> {
  31
  32     /**
  33      * Returns statement, which was explicit declaration of this effective
  34      * statement.
  35      *
  36      * @return statement, which was explicit declaration of this effective
  37      *         statement or null if statement was inferred from context.
  38      */
  39     @Nullable
  40     S getDeclared();
  41
  42     /**
  43      * Returns value associated with supplied identifier.
  44      *
  45      * @param <K> Identifier type
  46      * @param <V> Value type
  47      * @param <N> Namespace identifier type
  48      * @param namespace Namespace type
  49      * @param identifier Identifier of element.
  50      * @return Value if present, null otherwise.
  51      */
  52     //<K, V, N extends IdentifierNamespace<? super K, ? extends V>> V
  53     // FIXME: 3.0.0: make this return an Optional, not a nullable
  54     @Nullable
  55     <K, V, N extends IdentifierNamespace<K, V>> V get(@Nonnull Class<N> namespace, @Nonnull K identifier);
  56
  57     /**
  58      * Returns all local values from supplied namespace.
  59      *
  60      * @param <K> Identifier type
  61      * @param <V> Value type
  62      * @param <N> Namespace identifier type
  63      * @param namespace Namespace type
  64      * @return Value if present, null otherwise.
  65      */
  66     // FIXME: 3.0.0: make this contract return empty maps on non-presence
  67     @Nullable
  68     <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAll(@Nonnull Class<N> namespace);
  69
  70     /**
  71      * Returns all local values from supplied namespace.
  72      *
  73      * @param <K> Identifier type
  74      * @param <V> Value type
  75      * @param <N> Namespace identifier type
  76      * @param namespace Namespace type
  77      * @return Key-value mappings, empty if the namespace does not exist.
  78      */
  79     // FIXME: 3.0.0: remove this in favor of fixed getAll()
  80     default <K, V, N extends IdentifierNamespace<K, V>> @NonNull Map<K, V> findAll(@NonNull final Class<N> namespace) {
  81         final Map<K, V> map = getAll(requireNonNull(namespace));
  82         return map == null ? ImmutableMap.of() : map;
  83     }
  84
  85     /**
  86      * Returns a collection of all effective substatements.
  87      *
  88      * @return collection of all effective substatements.
  89      */
  90     @Nonnull Collection<? extends EffectiveStatement<?, ?>> effectiveSubstatements();
  91
  92     /**
  93      * Find the first effective substatement of specified type.
  94      *
  95      * @return First effective substatement, or empty if no match is found.
  96      */
  97     @Beta
  98     default <T extends EffectiveStatement<?, ?>> Optional<T> findFirstEffectiveSubstatement(
  99             @Nonnull final Class<T> type) {
 100         return effectiveSubstatements().stream().filter(type::isInstance).findFirst().map(type::cast);
 101     }
 102
 103     /**
 104      * Find the first effective substatement of specified type and return its value.
 105      *
 106      * @return First effective substatement's argument, or empty if no match is found.
 107      */
 108     @Beta
 109     default <V, T extends EffectiveStatement<V, ?>> Optional<V> findFirstEffectiveSubstatementArgument(
 110             @Nonnull final Class<T> type) {
 111         return findFirstEffectiveSubstatement(type).map(EffectiveStatement::argument);
 112     }
 113
 114     /**
 115      * Find all effective substatements of specified type and return them as a stream.
 116      *
 117      * @return A stream of all effective substatements of specified type.
 118      */
 119     @Beta
 120     default <T extends EffectiveStatement<?, ?>> Stream<T> streamEffectiveSubstatements(@Nonnull final Class<T> type) {
 121         return effectiveSubstatements().stream().filter(type::isInstance).map(type::cast);
 122     }
 123 }