BUG-8: mark deprecated classes as such
[controller.git] / opendaylight / md-sal / sal-common-util / src / main / java / org / opendaylight / controller / sal / common / util / CommitHandlerTransactions.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.sal.common.util;
9
10 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
11 import org.opendaylight.controller.md.sal.common.api.data.DataCommitHandler.DataCommitTransaction;
12 import org.opendaylight.yangtools.concepts.Path;
13 import org.opendaylight.yangtools.yang.common.RpcResult;
14 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
15
16 /**
17  * @deprecated Utility class for {@link DataCommitTransaction}, will be removed at the same time.
18  */
19 @Deprecated
20 public class CommitHandlerTransactions {
21
22     private static class AllwaysSuccessfulTransaction<P extends Path<P>,D> implements DataCommitTransaction<P, D> {
23
24         private final  DataModification<P, D> modification;
25
26         public AllwaysSuccessfulTransaction(DataModification<P, D> modification) {
27             this.modification = modification;
28         }
29         @Override
30         public RpcResult<Void> rollback() throws IllegalStateException {
31             return RpcResultBuilder.<Void>success().build();
32         }
33         @Override
34         public RpcResult<Void> finish() throws IllegalStateException {
35             return RpcResultBuilder.<Void>success().build();
36         }
37
38         @Override
39         public DataModification<P, D> getModification() {
40             return modification;
41         }
42     }
43
44     public static final <P extends Path<P>,D> AllwaysSuccessfulTransaction<P, D> allwaysSuccessfulTransaction(DataModification<P, D> modification)  {
45         return new AllwaysSuccessfulTransaction<>(modification);
46     }
47 }