Add Payload.serializedSize()
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / persisted / NoopPayload.java
1 /*
2  * Copyright (c) 2016 Brocade Communications 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.raft.persisted;
9
10 import akka.dispatch.ControlMessage;
11 import java.io.Serializable;
12 import org.apache.commons.lang3.SerializationUtils;
13 import org.opendaylight.controller.cluster.raft.messages.Payload;
14
15 /**
16  * Payload used for no-op log entries that are put into the journal by the PreLeader in order to commit
17  * entries from the prior term.
18  *
19  * @author Thomas Pantelis
20  */
21 public final class NoopPayload extends Payload implements ControlMessage {
22     public static final NoopPayload INSTANCE = new NoopPayload();
23
24     // There is no need for Externalizable
25     private static final class Proxy implements Serializable {
26         private static final long serialVersionUID = 1L;
27
28         private Object readResolve() {
29             return INSTANCE;
30         }
31     }
32
33     private static final long serialVersionUID = 1L;
34     private static final Proxy PROXY = new Proxy();
35     // Estimate to how big the proxy is. Note this includes object stream overhead, so it is a bit conservative
36     private static final int PROXY_SIZE = SerializationUtils.serialize(PROXY).length;
37
38     private NoopPayload() {
39         // Hidden on purpose
40     }
41
42     @Override
43     public int size() {
44         return 0;
45     }
46
47     @Override
48     public int serializedSize() {
49         return PROXY_SIZE;
50     }
51
52     @Override
53     protected Object writeReplace() {
54         return PROXY;
55     }
56 }