2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.modification;
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.api.schema.tree.DataTreeModification;
16 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;
19 * Represents a modification to the data store.
22 * Simple modifications can be of type,
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}
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.
34 public interface Modification extends Externalizable {
42 * Apply the modification to the specified transaction.
44 * @param transaction the transaction
46 void apply(DOMStoreWriteTransaction transaction);
49 * Apply the modification to the specified transaction.
51 * @param transaction the transaction
53 void apply(DataTreeModification transaction);
58 void writeExternal(ObjectOutput out) throws IOException;
61 void readExternal(ObjectInput in) throws IOException, ClassNotFoundException;
63 void writeTo(NormalizedNodeDataOutput out) throws IOException;