opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/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.controller.md.sal.dom.store.impl;
   9
  10 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
  11
  12 import com.google.common.base.Objects;
  13 import com.google.common.base.Objects.ToStringHelper;
  14 import com.google.common.base.Preconditions;
  15
  16 /**
  17  * Abstract DOM Store Transaction
  18  *
  19  * Convenience super implementation of DOM Store transaction which provides
  20  * common implementation of {@link #toString()} and {@link #getIdentifier()}.
  21  *
  22  *
  23  */
  24 abstract class AbstractDOMStoreTransaction implements DOMStoreTransaction {
  25     private final Object identifier;
  26
  27     protected AbstractDOMStoreTransaction(final Object identifier) {
  28         this.identifier = Preconditions.checkNotNull(identifier,"Identifier must not be null.");
  29     }
  30
  31     @Override
  32     public final Object getIdentifier() {
  33         return identifier;
  34     }
  35
  36     @Override
  37     public final String toString() {
  38         return addToStringAttributes(Objects.toStringHelper(this)).toString();
  39     }
  40
  41     /**
  42      * Add class-specific toString attributes.
  43      *
  44      * @param toStringHelper
  45      *            ToStringHelper instance
  46      * @return ToStringHelper instance which was passed in
  47      */
  48     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  49         return toStringHelper.add("id", identifier);
  50     }
  51 }