opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/modification/Modification.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
   9 package org.opendaylight.controller.cluster.datastore.modification;
  10
  11 import java.io.Externalizable;
  12 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  13 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  14
  15 /**
  16  * Represents a modification to the data store.
  17  *
  18  * <p>
  19  * Simple modifications can be of type,
  20  * <ul>
  21  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.WriteModification}
  22  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.MergeModification}
  23  * <li> {@link org.opendaylight.controller.cluster.datastore.modification.DeleteModification}
  24  * </ul>
  25  *
  26  * <p>
  27  * Modifications can in turn be lumped into a single
  28  * {@link org.opendaylight.controller.cluster.datastore.modification.CompositeModification}
  29  * which can then be applied to a write transaction.
  30  */
  31 public interface Modification extends Externalizable {
  32
  33     byte COMPOSITE = 1;
  34     byte WRITE = 2;
  35     byte MERGE = 3;
  36     byte DELETE = 4;
  37
  38     /**
  39      * Apply the modification to the specified transaction.
  40      *
  41      * @param transaction the transaction
  42      */
  43     void apply(DOMStoreWriteTransaction transaction);
  44
  45     /**
  46      * Apply the modification to the specified transaction.
  47      *
  48      * @param transaction the transaction
  49      */
  50     void apply(DataTreeModification transaction);
  51
  52     byte getType();
  53 }