org.opendaylight.controller.cluster.access.commands.TransactionModification Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation

Controller documentation

There is a newer version: 10.0.4

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.access.commands;

import static java.util.Objects.requireNonNull;

import com.google.common.base.MoreObjects;
import java.io.IOException;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.stream.ReusableStreamReceiver;
import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataOutput;

/**
 * An individual modification of a transaction's state. This class and its subclasses are not serializable, but rather
 * expose {@link #writeTo(NormalizedNodeDataOutput)} and
 * {@link #readFrom(NormalizedNodeDataInput, ReusableStreamReceiver)} methods for explicit serialization. The reason for
 * this is that they are usually transmitted in bulk, hence it is advantageous to reuse
 * a {@link NormalizedNodeDataOutput} instance to achieve better compression.
 */
public abstract class TransactionModification {
    static final byte TYPE_DELETE = 1;
    static final byte TYPE_MERGE = 2;
    static final byte TYPE_WRITE = 3;

    private final YangInstanceIdentifier path;

    TransactionModification(final YangInstanceIdentifier path) {
        this.path = requireNonNull(path);
    }

    public final YangInstanceIdentifier getPath() {
        return path;
    }

    @Override
    public final String toString() {
        return MoreObjects.toStringHelper(this).add("path", path).toString();
    }

    abstract byte getType();

    void writeTo(final NormalizedNodeDataOutput out) throws IOException {
        out.writeByte(getType());
        out.writeYangInstanceIdentifier(path);
    }

    static TransactionModification readFrom(final NormalizedNodeDataInput in, final ReusableStreamReceiver writer)
            throws IOException {
        final byte type = in.readByte();
        return switch (type) {
            case TYPE_DELETE -> new TransactionDelete(in.readYangInstanceIdentifier());
            case TYPE_MERGE -> new TransactionMerge(in.readYangInstanceIdentifier(), in.readNormalizedNode(writer));
            case TYPE_WRITE -> new TransactionWrite(in.readYangInstanceIdentifier(), in.readNormalizedNode(writer));
            default -> throw new IllegalArgumentException("Unhandled type " + type);
        };
    }
}