Add DOMQueryResult streaming interfaces
[mdsal.git] / dom / mdsal-dom-api / src / main / java / org / opendaylight / mdsal / dom / api / query / DOMQueryResult.java
1 /*
2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.mdsal.dom.api.query;
9
10 import com.google.common.annotations.Beta;
11 import java.util.List;
12 import java.util.Map.Entry;
13 import java.util.Spliterator;
14 import java.util.stream.Collectors;
15 import java.util.stream.Stream;
16 import org.eclipse.jdt.annotation.NonNullByDefault;
17 import org.opendaylight.yangtools.concepts.Immutable;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
20
21 /**
22  * An object holding the results of a {@link DOMQuery} execution.
23  */
24 @Beta
25 @NonNullByDefault
26 public interface DOMQueryResult extends Immutable {
27
28     Spliterator<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> spliterator();
29
30     Stream<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> stream();
31
32     Stream<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> parallelStream();
33
34     default List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> items() {
35         return stream().collect(Collectors.toUnmodifiableList());
36     }
37 }