a387d30b27382d61fb3f5ebbb3e261cbe53a03fb
[controller.git] / opendaylight / md-sal / sal-binding-api / src / main / java / org / opendaylight / controller / md / sal / binding / api / DataTreeIdentifier.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.controller.md.sal.binding.api;
9
10 import static java.util.Objects.requireNonNull;
11
12 import java.io.Serializable;
13 import org.eclipse.jdt.annotation.NonNull;
14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
15 import org.opendaylight.yangtools.concepts.Immutable;
16 import org.opendaylight.yangtools.concepts.Path;
17 import org.opendaylight.yangtools.yang.binding.DataObject;
18 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
19
20 /**
21  * A unique identifier for a particular subtree. It is composed of the logical
22  * data store type and the instance identifier of the root node.
23  *
24  * @deprecated Use {@link org.opendaylight.mdsal.binding.api.DataTreeIdentifier} instead.
25  */
26 @Deprecated
27 public final class DataTreeIdentifier<T extends DataObject> implements Immutable,
28         Path<DataTreeIdentifier<?>>, Serializable {
29     private static final long serialVersionUID = 1L;
30
31     private final @NonNull InstanceIdentifier<T> rootIdentifier;
32     private final @NonNull LogicalDatastoreType datastoreType;
33
34     public DataTreeIdentifier(final LogicalDatastoreType datastoreType, final InstanceIdentifier<T> rootIdentifier) {
35         this.datastoreType = requireNonNull(datastoreType);
36         this.rootIdentifier = requireNonNull(rootIdentifier);
37     }
38
39     /**
40      * Return the logical data store type.
41      *
42      * @return Logical data store type. Guaranteed to be non-null.
43      */
44     public @NonNull LogicalDatastoreType getDatastoreType() {
45         return datastoreType;
46     }
47
48     /**
49      * Return the {@link InstanceIdentifier} of the root node.
50      *
51      * @return Instance identifier corresponding to the root node.
52      */
53     public @NonNull InstanceIdentifier<T> getRootIdentifier() {
54         return rootIdentifier;
55     }
56
57     @Override
58     public boolean contains(final DataTreeIdentifier<?> other) {
59         return datastoreType == other.datastoreType && rootIdentifier.contains(other.rootIdentifier);
60     }
61
62     @Override
63     public int hashCode() {
64         final int prime = 31;
65         int result = 1;
66         result = prime * result + datastoreType.hashCode();
67         result = prime * result + rootIdentifier.hashCode();
68         return result;
69     }
70
71     @Override
72     public boolean equals(final Object obj) {
73         if (this == obj) {
74             return true;
75         }
76         if (!(obj instanceof DataTreeIdentifier)) {
77             return false;
78         }
79         final DataTreeIdentifier<?> other = (DataTreeIdentifier<?>) obj;
80         if (datastoreType != other.datastoreType) {
81             return false;
82         }
83         return rootIdentifier.equals(other.rootIdentifier);
84     }
85
86     @Override
87     public String toString() {
88         return getClass().getSimpleName() + "{datastoreType = " + datastoreType + ", rootIdentifier = "
89                 + rootIdentifier + "}";
90     }
91 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.