CLEANUP : Fix javadoc warnings in sal-akka-raft code
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / ReplicatedLogEntry.java
1 /*
2  * Copyright (c) 2014 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
9 package org.opendaylight.controller.cluster.raft;
10
11 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
12
13 /**
14  * Represents one entry in the replicated log
15  */
16 public interface ReplicatedLogEntry {
17     /**
18      *
19      * @return The payload/data to be replicated
20      */
21     Payload getData();
22
23     /**
24      *
25      * @return The term of the entry
26      */
27     long getTerm();
28
29     /**
30      *
31      * @return The index of the entry
32      */
33     long getIndex();
34
35     /**
36      *
37      * @return The size of the entry in bytes. An approximate number may be good enough.
38      */
39     int size();
40 }