Fix warnings/javadocs in sal-distributed-datastore
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / FrontendShardDataTreeSnapshotMetadata.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.MoreObjects;
11 import com.google.common.collect.ImmutableList;
12 import java.io.Externalizable;
13 import java.io.IOException;
14 import java.io.ObjectInput;
15 import java.io.ObjectOutput;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.List;
19
20 public final class FrontendShardDataTreeSnapshotMetadata extends
21         ShardDataTreeSnapshotMetadata<FrontendShardDataTreeSnapshotMetadata> {
22
23     private static final class Proxy implements Externalizable {
24         private static final long serialVersionUID = 1L;
25
26         private List<FrontendClientMetadata> clients;
27
28         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
29         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
30         @SuppressWarnings("checkstyle:RedundantModifier")
31         public Proxy() {
32             // For Externalizable
33         }
34
35         Proxy(final FrontendShardDataTreeSnapshotMetadata metadata) {
36             this.clients = metadata.getClients();
37         }
38
39         @Override
40         public void writeExternal(final ObjectOutput out) throws IOException {
41             out.writeInt(clients.size());
42             for (final FrontendClientMetadata c : clients) {
43                 c.writeTo(out);
44             }
45         }
46
47         @Override
48         public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
49             final int size = in.readInt();
50             final List<FrontendClientMetadata> readedClients = new ArrayList<>(size);
51             for (int i = 0; i < size ; ++i) {
52                 readedClients.add(FrontendClientMetadata.readFrom(in));
53             }
54             this.clients = ImmutableList.copyOf(readedClients);
55         }
56
57         private Object readResolve() {
58             return new FrontendShardDataTreeSnapshotMetadata(clients);
59         }
60     }
61
62     private static final long serialVersionUID = 1L;
63
64     private final List<FrontendClientMetadata> clients;
65
66     public FrontendShardDataTreeSnapshotMetadata(final Collection<FrontendClientMetadata> clients) {
67         this.clients = ImmutableList.copyOf(clients);
68     }
69
70     public List<FrontendClientMetadata> getClients() {
71         return clients;
72     }
73
74     @Override
75     protected Externalizable externalizableProxy() {
76         return new Proxy(this);
77     }
78
79     @Override
80     public Class<FrontendShardDataTreeSnapshotMetadata> getType() {
81         return FrontendShardDataTreeSnapshotMetadata.class;
82     }
83
84     @Override
85     public String toString() {
86         return MoreObjects.toStringHelper(FrontendShardDataTreeSnapshotMetadata.class).add("clients", clients)
87                 .toString();
88     }
89 }