Fixup javadoc
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / ShardDataTreeSnapshotMetadata.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.base.Verify;
11 import java.io.Externalizable;
12 import java.io.Serializable;
13 import javax.annotation.Nonnull;
14
15 /**
16  * Base class for various bits of metadata attached to a {@link MetadataShardDataTreeSnapshot}. This class is not
17  * an interface because we want to make sure all subclasses implement the externalizable proxy pattern, for which
18  * we need to force {@link #writeReplace()} to be abstract. We do that by making it final and exposing a protected
19  * {@link #externalizableProxy()} method.
20  * <p/>
21  * All concrete subclasses of this class should be final so as to form a distinct set of possible metadata. Since
22  * metadata is serialized along with {@link MetadataShardDataTreeSnapshot}, this set is part of the serialization format
23  * guarded by {@link PayloadVersion}.
24  * <p/>
25  * If a new metadata type is introduced or a type is removed, {@link PayloadVersion} needs to be bumped to ensure
26  * compatibility.
27  *
28  * @author Robert Varga
29  */
30 public abstract class ShardDataTreeSnapshotMetadata<T extends ShardDataTreeSnapshotMetadata<T>>
31         implements Serializable {
32     private static final long serialVersionUID = 1L;
33
34     ShardDataTreeSnapshotMetadata() {
35         // Prevent subclassing from outside of this package
36     }
37
38     final Object writeReplace() {
39         return Verify.verifyNotNull(externalizableProxy(), "Null externalizable proxy from %s", getClass());
40     }
41
42     /**
43      * Return an Externalizable proxy.
44      *
45      * @return Externalizable proxy, may not be null
46      */
47     protected abstract @Nonnull Externalizable externalizableProxy();
48
49     public abstract Class<T> getType();
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.