Fix checkstyle violations in sal-common-api
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / data / 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.controller.md.sal.common.api.data;
9
10 import org.opendaylight.yangtools.concepts.Identifiable;
11 import org.opendaylight.yangtools.concepts.Path;
12
13
14 /**
15  * A common parent for all transactions which operate on a conceptual data tree.
16  *
17  * <p>
18  * See derived transaction types for more concrete behavior:
19  * <ul>
20  * <li>{@link AsyncReadTransaction} - Read capabilities, user is able to read data from data tree</li>
21  * <li>{@link AsyncWriteTransaction} - Write capabilities, user is able to propose changes to data tree</li>
22  * <li>{@link AsyncReadWriteTransaction} - Read and Write capabilities, user is able to read state and to propose
23  *     changes of state.</li>
24  * </ul>
25  *
26  * <b>Implementation Note:</b> This interface is not intended to be implemented
27  * by users of MD-SAL.
28  *
29  * @param <P> Type of path (subtree identifier), which represents location in tree
30  * @param <D> Type of data (payload), which represents data payload
31  */
32 public interface AsyncTransaction<P extends Path<P>,D> extends //
33     Identifiable<Object> {
34
35     @Override
36     Object getIdentifier();
37 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.