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