dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/store/AbstractDOMStoreTransaction.java

   1 /*
   2  * Copyright (c) 2014 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.dom.spi.store;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17
  18 /**
  19  * Abstract DOM Store Transaction.
  20  * Convenience super implementation of DOM Store transaction which provides common implementation of
  21  * {@link #toString()} and {@link #getIdentifier()}.
  22  * It can optionally capture the context where it was allocated.
  23  *
  24  * @param <T> identifier type
  25  */
  26 @Beta
  27 @NonNullByDefault
  28 public abstract class AbstractDOMStoreTransaction<T> implements DOMStoreTransaction {
  29     private final @Nullable Throwable debugContext;
  30     private final T identifier;
  31
  32     protected AbstractDOMStoreTransaction(final T identifier) {
  33         this(identifier, false);
  34     }
  35
  36     protected AbstractDOMStoreTransaction(final T identifier, final boolean debug) {
  37         this.identifier = requireNonNull(identifier, "Identifier must not be null.");
  38         this.debugContext = debug ? new Throwable().fillInStackTrace() : null;
  39     }
  40
  41     @Override
  42     public final T getIdentifier() {
  43         return identifier;
  44     }
  45
  46     /**
  47      * Return the context in which this transaction was allocated.
  48      *
  49      * @return The context in which this transaction was allocated, or null
  50      *         if the context was not recorded.
  51      */
  52     public final @Nullable Throwable getDebugContext() {
  53         return debugContext;
  54     }
  55
  56     @Override
  57     public final String toString() {
  58         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
  59     }
  60
  61     /**
  62      * Add class-specific toString attributes.
  63      *
  64      * @param toStringHelper
  65      *            ToStringHelper instance
  66      * @return ToStringHelper instance which was passed in
  67      */
  68     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  69         return toStringHelper.add("id", identifier);
  70     }
  71 }