7a8bd4648bad5ff0b49bc0bed74d6b47c8d55653
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / ShardDataTreeSnapshot.java
1 /*
2  * Copyright (c) 2016 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.persisted;
9
10 import com.google.common.annotations.Beta;
11 import java.io.IOException;
12 import java.io.ObjectInput;
13 import java.io.ObjectOutput;
14 import java.util.Optional;
15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
16
17 /**
18  * Abstract base class for snapshots of the ShardDataTree.
19  *
20  * @author Robert Varga
21  */
22 @Beta
23 public abstract class ShardDataTreeSnapshot {
24     ShardDataTreeSnapshot() {
25         // Hidden to prevent subclassing from outside of this package
26     }
27
28     public static ShardDataTreeSnapshot deserialize(final ObjectInput in) throws IOException {
29         final ShardDataTreeSnapshot ret = AbstractVersionedShardDataTreeSnapshot.versionedDeserialize(in);
30
31         // Make sure we consume all bytes, otherwise something went very wrong
32         final int bytesLeft = in.available();
33         if (bytesLeft != 0) {
34             throw new IOException("Deserialization left " + bytesLeft + " in the buffer");
35         }
36
37
38         return ret;
39     }
40
41     /**
42      * Get the root data node contained in this snapshot.
43      *
44      * @return An optional root node.
45      */
46     public abstract Optional<NormalizedNode<?, ?>> getRootNode();
47
48     public abstract void serialize(ObjectOutput out) throws IOException;
49 }
50

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.