common/mdsal-common-api/src/main/java/org/opendaylight/mdsal/common/api/AsyncTransaction.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.common.api;
   9
  10 import org.opendaylight.yangtools.concepts.Identifiable;
  11 import org.opendaylight.yangtools.concepts.Path;
  12
  13 /**
  14  * A common parent for all transactions which operate on a conceptual data tree.
  15  * See derived transaction types for more concrete behavior:
  16  * <ul>
  17  * <li>{@link AsyncReadTransaction} - Read capabilities, user is able to read data from data tree</li>
  18  * <li>{@link AsyncWriteTransaction} - Write capabilities, user is able to propose changes to data tree</li>
  19  * </ul>
  20  *
  21  * <b>Implementation Note:</b> This interface is not intended to be implemented
  22  * by users of MD-SAL.
  23  *
  24  * @param <P> Type of path (subtree identifier), which represents location in tree
  25  * @param <D> Type of data (payload), which represents data payload
  26  * @deprecated This interface is being removed.  Use either {@code org.opendaylight.mdsal.binding.api.Transaction}
  27  *             or {@code org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction} instead.
  28  */
  29 @Deprecated
  30 public interface AsyncTransaction<P extends Path<P>,D> extends Identifiable<Object> {
  31     @Override
  32     Object getIdentifier();
  33 }