2 * Copyright (c) 2014 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.controller.sal.core.spi.data;
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.base.MoreObjects.ToStringHelper;
13 import com.google.common.base.Preconditions;
14 import javax.annotation.Nonnull;
15 import javax.annotation.Nullable;
18 * Abstract DOM Store Transaction.
20 * Convenience super implementation of DOM Store transaction which provides
21 * common implementation of {@link #toString()} and {@link #getIdentifier()}.
23 * It can optionally capture the context where it was allocated.
28 public abstract class AbstractDOMStoreTransaction<T> implements DOMStoreTransaction {
29 private final Throwable debugContext;
30 private final T identifier;
32 protected AbstractDOMStoreTransaction(@Nonnull final T identifier) {
33 this(identifier, false);
36 protected AbstractDOMStoreTransaction(@Nonnull final T identifier, final boolean debug) {
37 this.identifier = Preconditions.checkNotNull(identifier, "Identifier must not be null.");
38 this.debugContext = debug ? new Throwable().fillInStackTrace() : null;
42 public final T getIdentifier() {
47 * Return the context in which this transaction was allocated.
49 * @return The context in which this transaction was allocated, or null
50 * if the context was not recorded.
52 @Nullable public final Throwable getDebugContext() {
57 public final String toString() {
58 return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
62 * Add class-specific toString attributes.
64 * @param toStringHelper
65 * ToStringHelper instance
66 * @return ToStringHelper instance which was passed in
68 protected ToStringHelper addToStringAttributes(@Nonnull final ToStringHelper toStringHelper) {
69 return toStringHelper.add("id", identifier);