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