2 * Copyright (c) 2016 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.access.commands;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.MoreObjects;
14 import java.io.IOException;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.schema.stream.ReusableStreamReceiver;
17 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
18 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;
21 * An individual modification of a transaction's state. This class and its subclasses are not serializable, but rather
22 * expose {@link #writeTo(NormalizedNodeDataOutput)} and
23 * {@link #readFrom(NormalizedNodeDataInput, ReusableStreamReceiver)} methods for explicit serialization. The reason for
24 * this is that they are usually transmitted in bulk, hence it is advantageous to reuse
25 * a {@link NormalizedNodeDataOutput} instance to achieve better compression.
27 * @author Robert Varga
30 public abstract class TransactionModification {
31 static final byte TYPE_DELETE = 1;
32 static final byte TYPE_MERGE = 2;
33 static final byte TYPE_WRITE = 3;
35 private final YangInstanceIdentifier path;
37 TransactionModification(final YangInstanceIdentifier path) {
38 this.path = requireNonNull(path);
41 public final YangInstanceIdentifier getPath() {
46 public final String toString() {
47 return MoreObjects.toStringHelper(this).add("path", path).toString();
50 abstract byte getType();
52 void writeTo(final NormalizedNodeDataOutput out) throws IOException {
53 out.writeByte(getType());
54 out.writeYangInstanceIdentifier(path);
57 static TransactionModification readFrom(final NormalizedNodeDataInput in, final ReusableStreamReceiver writer)
59 final byte type = in.readByte();
62 return new TransactionDelete(in.readYangInstanceIdentifier());
64 return new TransactionMerge(in.readYangInstanceIdentifier(), in.readNormalizedNode(writer));
66 return new TransactionWrite(in.readYangInstanceIdentifier(), in.readNormalizedNode(writer));
68 throw new IllegalArgumentException("Unhandled type " + type);