opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncReadOnlyTransaction.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.Path;
  11
  12 /**
  13  * Read-only transaction, which provides stable view of data
  14  * and is {@link AutoCloseable} resource.
  15  *
  16  * @see AsyncReadTransaction
  17  *
  18 * @param <P>
  19  *            Type of path (subtree identifier), which represents location in
  20  *            tree
  21  * @param <D>
  22  *            Type of data (payload), which represents data payload
  23  */
  24 public interface AsyncReadOnlyTransaction<P extends Path<P>, D> extends AsyncReadTransaction<P, D>, AutoCloseable {
  25
  26     /**
  27      * Closes transaction and releases all resources associated with it.
  28      *
  29      */
  30     @Override
  31     public void close();
  32 }