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