binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/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.mdsal.binding.api;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.io.Serializable;
  12 import javax.annotation.Nonnull;
  13 import org.opendaylight.mdsal.common.api.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     private DataTreeIdentifier(final LogicalDatastoreType datastoreType, final InstanceIdentifier<T> rootIdentifier) {
  30         this.datastoreType = Preconditions.checkNotNull(datastoreType);
  31         this.rootIdentifier = Preconditions.checkNotNull(rootIdentifier);
  32     }
  33
  34     public static <T extends DataObject> DataTreeIdentifier<T> create(final LogicalDatastoreType datastoreType,
  35             final InstanceIdentifier<T> rootIdentifier) {
  36         return new DataTreeIdentifier<>(datastoreType, 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 }