2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.api;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.MoreObjects;
13 import java.io.Serializable;
14 import org.eclipse.jdt.annotation.NonNull;
15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
16 import org.opendaylight.yangtools.concepts.Immutable;
17 import org.opendaylight.yangtools.concepts.Path;
18 import org.opendaylight.yangtools.yang.binding.DataObject;
19 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
22 * A unique identifier for a particular subtree. It is composed of the logical
23 * data store type and the instance identifier of the root node.
25 public final class DataTreeIdentifier<T extends DataObject> implements Immutable,
26 Path<DataTreeIdentifier<?>>, Serializable {
27 private static final long serialVersionUID = 1L;
29 private final @NonNull InstanceIdentifier<T> rootIdentifier;
30 private final @NonNull LogicalDatastoreType datastoreType;
32 private DataTreeIdentifier(final @NonNull LogicalDatastoreType datastoreType,
33 final @NonNull InstanceIdentifier<T> rootIdentifier) {
34 this.datastoreType = requireNonNull(datastoreType);
35 this.rootIdentifier = requireNonNull(rootIdentifier);
38 public static <T extends DataObject> @NonNull DataTreeIdentifier<T> create(
39 final @NonNull LogicalDatastoreType datastoreType, final @NonNull InstanceIdentifier<T> rootIdentifier) {
40 return new DataTreeIdentifier<>(datastoreType, rootIdentifier);
44 * Return the logical data store type.
46 * @return Logical data store type. Guaranteed to be non-null.
48 public @NonNull LogicalDatastoreType getDatastoreType() {
53 * Return the {@link InstanceIdentifier} of the root node.
55 * @return Instance identifier corresponding to the root node.
57 public @NonNull InstanceIdentifier<T> getRootIdentifier() {
58 return rootIdentifier;
62 public boolean contains(final DataTreeIdentifier<?> other) {
63 return datastoreType == other.datastoreType && rootIdentifier.contains(other.rootIdentifier);
67 public int hashCode() {
70 result = prime * result + datastoreType.hashCode();
71 result = prime * result + rootIdentifier.hashCode();
76 public boolean equals(final Object obj) {
80 if (!(obj instanceof DataTreeIdentifier)) {
83 final DataTreeIdentifier<?> other = (DataTreeIdentifier<?>) obj;
84 if (datastoreType != other.datastoreType) {
87 return rootIdentifier.equals(other.rootIdentifier);
91 public String toString() {
92 return MoreObjects.toStringHelper(this).add("datastore", datastoreType).add("root", rootIdentifier).toString();