71386624cc9488214e751adfc976f9a2607e94b9
[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 com.google.common.collect.ImmutableList;
12 import java.util.List;
13 import java.util.Map.Entry;
14 import org.eclipse.jdt.annotation.NonNullByDefault;
15 import org.opendaylight.yangtools.concepts.Immutable;
16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
18
19 /**
20  * An object holding the results of a {@link DOMQuery} execution.
21  */
22 @Beta
23 @NonNullByDefault
24 public final class DOMQueryResult implements Immutable {
25     private static final DOMQueryResult EMPTY_INSTANCE = new DOMQueryResult(ImmutableList.of());
26
27     private final ImmutableList<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> items;
28
29     private DOMQueryResult(final List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> items) {
30         this.items = ImmutableList.copyOf(items);
31     }
32
33     public static DOMQueryResult of() {
34         return EMPTY_INSTANCE;
35     }
36
37     public static DOMQueryResult of(final List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> items) {
38         return items.isEmpty() ? of() : new DOMQueryResult(items);
39     }
40
41     public List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> items() {
42         return items;
43     }
44 }