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